Skip to content

yelp

YelpDatasetConfig dataclass

Bases: DatasetConfig

Yelp dataset configuration.

Note: Yelp dataset must be manually downloaded from https://www.yelp.com/dataset/download as it requires acceptance of a license agreement. The dataset should be converted from JSON to CSV and placed in the data directory.

Source code in src/recnexteval/datasets/config/yelp.py
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
@dataclass
class YelpDatasetConfig(DatasetConfig):
    """Yelp dataset configuration.

    Note: Yelp dataset must be manually downloaded from https://www.yelp.com/dataset/download
    as it requires acceptance of a license agreement. The dataset should be converted
    from JSON to CSV and placed in the data directory.
    """

    user_ix: str = "user_id"
    item_ix: str = "business_id"
    timestamp_ix: str = "date"
    rating_ix: str = "stars"
    dataset_url: str = "https://www.yelp.com/dataset/download"
    remote_filename: str = "yelp_academic_dataset_review.csv"

    @property
    def default_filename(self) -> str:
        """Return the default filename for Yelp dataset."""
        return self.remote_filename

user_ix = 'user_id' class-attribute instance-attribute

item_ix = 'business_id' class-attribute instance-attribute

timestamp_ix = 'date' class-attribute instance-attribute

rating_ix = 'stars' class-attribute instance-attribute

dataset_url = 'https://www.yelp.com/dataset/download' class-attribute instance-attribute

remote_filename = 'yelp_academic_dataset_review.csv' class-attribute instance-attribute

default_filename property

Return the default filename for Yelp dataset.

default_base_path = str(get_data_dir()) class-attribute instance-attribute

Default base path where the dataset will be stored.

remote_zipname = '' class-attribute instance-attribute