Update README.md

README.md

@@ -178,51 +178,50 @@ from datasets import load_dataset
 ds = load_dataset("yandex/yambda", data_dir="flat/50m", data_files="likes.parquet")
 ```
 
-Also, we provide simple wrapper for convenient
-usage
+Also, we provide simple wrapper for convenient usage:
 ```python
 from typing import Literal
-
 from datasets import Dataset, DatasetDict, load_dataset
 
-
 class YambdaDataset:
-    INTERACTIONS = frozenset(["likes", "listens", "multi_event", "dislikes", "unlikes", "undislikes"])
+    INTERACTIONS = frozenset([
+        "likes", "listens", "multi_event", "dislikes", "unlikes", "undislikes"
+    ])
 
     def __init__(
-        self, dataset_type: Literal["flat", "sequential"] = "flat", dataset_size: Literal["50m", "500m", "5b"] = "50m"
+        self,
+        dataset_type: Literal["flat", "sequential"] = "flat",
+        dataset_size: Literal["50m", "500m", "5b"] = "50m"
     ):
         assert dataset_type in {"flat", "sequential"}
         assert dataset_size in {"50m", "500m", "5b"}
-
         self.dataset_type = dataset_type
         self.dataset_size = dataset_size
 
-    def interaction(
-        self, type: Literal["likes", "listens", "multi_event", "dislikes", "unlikes", "undislikes"]
-    ) -> Dataset:
-        assert type in YambdaDataset.INTERACTIONS
-
-        return YambdaDataset._download(f"{self.dataset_type}/{self.dataset_size}", type)
+    def interaction(self, event_type: Literal[
+        "likes", "listens", "multi_event", "dislikes", "unlikes", "undislikes"
+    ]) -> Dataset:
+        assert event_type in YambdaDataset.INTERACTIONS
+        return self._download(f"{self.dataset_type}/{self.dataset_size}", event_type)
 
     def audio_embeddings(self) -> Dataset:
-        return YambdaDataset._download("", "embeddings")
+        return self._download("", "embeddings")
 
     def album_item_mapping(self) -> Dataset:
-        return YambdaDataset._download("", "album_item_mapping")
+        return self._download("", "album_item_mapping")
 
     def artist_item_mapping(self) -> Dataset:
-        return YambdaDataset._download("", "artist_item_mapping")
+        return self._download("", "artist_item_mapping")
 
     @staticmethod
     def _download(data_dir: str, file: str) -> Dataset:
         data = load_dataset("yandex/yambda", data_dir=data_dir, data_files=f"{file}.parquet")
+        # Returns DatasetDict; extracting the only split
         assert isinstance(data, DatasetDict)
         return data["train"]
 
 dataset = YambdaDataset("flat", "50m")
-
-likes = dataset.interaction("likes")
+likes = dataset.interaction("likes")  # returns a HuggingFace Dataset
 ```
 
 ## FAQ