src.fairreckitlib.core.core_constants

This module contains configuration constants that are used in other packages.

Constants:

ELLIOT_API: name of the Elliot API.
IMPLICIT_API: name of the Implicit API.
LENSKIT_API: name of the LensKit API.
REXMEX_API: name of the Rexmex API.
SURPRISE_API: name of the Surprise API.

KEY_NAME: the key that is used for a name.
KEY_PARAMS: the key that is used for params.
KEY_RANDOM_SEED: the key that is used for a random seed param.
KEY_TYPE: the key that is used for types.

TYPE_PREDICTION: the prediction experiment type.
TYPE_RECOMMENDATION: the recommender experiment type.

VALID_TYPES: the valid experiment types.

KEY_TOP_K: the key that is used for top k.
KEY_RATED_ITEMS_FILTER: the key that is used for the rated items filter.

DEFAULT_TOP_K: the default top k for recommender experiments.
DEFAULT_RATED_ITEMS_FILTER: the default rated items filter for recommender experiments.

MIN_TOP_K: the minimum top k for recommender experiments.
MAX_TOP_K: the maximum top k for recommender experiments.

MODEL_USER_BATCH_SIZE: the batch size of users that is used when model computations are done.
MODEL_RATINGS_FILE: the file that is used to store the computed model ratings.

This program has been developed by students from the bachelor Computer Science at Utrecht University within the Software Project course. © Copyright Utrecht University (Department of Information and Computing Sciences)

View Source

 1"""This module contains configuration constants that are used in other packages.
 2
 3Constants:
 4
 5    ELLIOT_API: name of the Elliot API.
 6    IMPLICIT_API: name of the Implicit API.
 7    LENSKIT_API: name of the LensKit API.
 8    REXMEX_API: name of the Rexmex API.
 9    SURPRISE_API: name of the Surprise API.
10
11    KEY_NAME: the key that is used for a name.
12    KEY_PARAMS: the key that is used for params.
13    KEY_RANDOM_SEED: the key that is used for a random seed param.
14    KEY_TYPE: the key that is used for types.
15
16    TYPE_PREDICTION: the prediction experiment type.
17    TYPE_RECOMMENDATION: the recommender experiment type.
18
19    VALID_TYPES: the valid experiment types.
20
21    KEY_TOP_K: the key that is used for top k.
22    KEY_RATED_ITEMS_FILTER: the key that is used for the rated items filter.
23
24    DEFAULT_TOP_K: the default top k for recommender experiments.
25    DEFAULT_RATED_ITEMS_FILTER: the default rated items filter for recommender experiments.
26
27    MIN_TOP_K: the minimum top k for recommender experiments.
28    MAX_TOP_K: the maximum top k for recommender experiments.
29
30    MODEL_USER_BATCH_SIZE: the batch size of users that is used when model computations are done.
31    MODEL_RATINGS_FILE: the file that is used to store the computed model ratings.
32
33This program has been developed by students from the bachelor Computer Science at
34Utrecht University within the Software Project course.
35© Copyright Utrecht University (Department of Information and Computing Sciences)
36"""
37
38ELLIOT_API = 'Elliot' # no longer supported
39IMPLICIT_API = 'Implicit'
40LENSKIT_API = 'LensKit'
41REXMEX_API = 'Rexmex'
42SURPRISE_API = 'Surprise'
43
44KEY_NAME = 'name'
45KEY_PARAMS = 'params'
46KEY_RANDOM_SEED = 'seed'
47KEY_TYPE = 'type'
48
49TYPE_PREDICTION = 'prediction'
50TYPE_RECOMMENDATION = 'recommendation'
51
52VALID_TYPES = [TYPE_PREDICTION, TYPE_RECOMMENDATION]
53
54KEY_TOP_K = 'top_K'
55KEY_RATED_ITEMS_FILTER = 'rated_items_filter'
56
57DEFAULT_TOP_K = 10
58DEFAULT_RATED_ITEMS_FILTER = True
59
60MIN_TOP_K = 1
61MAX_TOP_K = 100
62
63MODEL_USER_BATCH_SIZE = 10000
64MODEL_RATINGS_FILE = 'ratings.tsv'