recpack.datasets.CiteULike

class recpack.datasets.CiteULike(path: str = 'data', filename: Optional[str] = None, use_default_filters=True)

Dataset class for the CiteULike dataset.

Full information on the dataset can be found at https://github.com/js05212/citeulike-a. Uses the users.dat file from the dataset to construct an implicit feedback interaction matrix.

Default processing makes sure that:

  • Each remaining user has interacted with at least 3 items

  • Each remaining item has been interacted with by at least 5 users

Parameters
  • path (str, optional) – The path to the data directory. Defaults to data

  • filename (str, optional) – Name of the file, if no name is provided the dataset default will be used if known. If the dataset does not have a default filename, a ValueError will be raised.

  • use_default_filters (bool, optional) – Should a default set of filters be initialised? Defaults to True

Methods

add_filter(_filter[, index])

Add a filter to be applied when loading the data.

fetch_dataset([force])

Check if dataset is present, if not download

load()

Loads data into an InteractionMatrix object.

Attributes

DEFAULT_FILENAME

Default filename that will be used if it is not specified by the user.

ITEM_IX

name of the column in the loaded DataFrame with item identifiers

TIMESTAMP_IX

The dataset has no notion of time, so there is no timestamp column present in the DataFrame.

USER_IX

name of the column in the loaded DataFrame with user identifiers

file_path

The fully classified path to the file from which dataset will be loaded.

DEFAULT_FILENAME = 'users.dat'

Default filename that will be used if it is not specified by the user.

TIMESTAMP_IX = None

The dataset has no notion of time, so there is no timestamp column present in the DataFrame.

add_filter(_filter: recpack.preprocessing.filters.Filter, index=None)

Add a filter to be applied when loading the data.

If the index is specified, the filter is inserted at the specified index. Otherwise it is appended.

Parameters
  • _filter (Filter) – Filter to be applied to the loaded DataFrame processing to interaction matrix.

  • index (int) – The index to insert the filter at, None will append the filter. Defaults to None

fetch_dataset(force=False)

Check if dataset is present, if not download

Parameters

force (bool, optional) – If True, dataset will be downloaded, even if the file already exists. Defaults to False.

property file_path

The fully classified path to the file from which dataset will be loaded.

load() recpack.matrix.interaction_matrix.InteractionMatrix

Loads data into an InteractionMatrix object.

Data is loaded into a DataFrame using the _load_dataframe function. Resulting DataFrame is parsed into an InteractionMatrix object. During parsing the filters are applied in order.

Returns

The resulting InteractionMatrix

Return type

InteractionMatrix