src.fairreckitlib.evaluation.evaluation_sets

This module contains evaluation sets file paths and dataframes definition.

Classes:

EvaluationSetPaths: the file paths of the evaluation sets.
EvaluationSets: the dataframes of the evaluation sets.

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)

 1"""This module contains evaluation sets file paths and dataframes definition.
 2
 3Classes:
 4
 5    EvaluationSetPaths: the file paths of the evaluation sets.
 6    EvaluationSets: the dataframes of the evaluation sets.
 7
 8This program has been developed by students from the bachelor Computer Science at
 9Utrecht University within the Software Project course.
10© Copyright Utrecht University (Department of Information and Computing Sciences)
11"""
12
13from dataclasses import dataclass
14from typing import Optional
15
16import pandas as pd
17
18
19@dataclass
20class EvaluationSetPaths:
21    """Evaluation set file paths.
22
23    ratings_path: the computed rating set file path.
24    train_path: the train set file path.
25    test_path: the test set file path.
26    """
27
28    ratings_path: str
29    train_path: str
30    test_path: str
31
32
33@dataclass
34class EvaluationSets:
35    """Evaluation set dataframes.
36
37    ratings: the computed ratings set.
38    train: the train set or None when not needed for evaluation.
39    test: the test set or None when not needed for evaluation.
40    """
41
42    ratings: pd.DataFrame
43    train: Optional[pd.DataFrame]
44    test: Optional[pd.DataFrame]
@dataclass
class EvaluationSetPaths:
20@dataclass
21class EvaluationSetPaths:
22    """Evaluation set file paths.
23
24    ratings_path: the computed rating set file path.
25    train_path: the train set file path.
26    test_path: the test set file path.
27    """
28
29    ratings_path: str
30    train_path: str
31    test_path: str

Evaluation set file paths.

ratings_path: the computed rating set file path. train_path: the train set file path. test_path: the test set file path.

EvaluationSetPaths(ratings_path: str, train_path: str, test_path: str)
@dataclass
class EvaluationSets:
34@dataclass
35class EvaluationSets:
36    """Evaluation set dataframes.
37
38    ratings: the computed ratings set.
39    train: the train set or None when not needed for evaluation.
40    test: the test set or None when not needed for evaluation.
41    """
42
43    ratings: pd.DataFrame
44    train: Optional[pd.DataFrame]
45    test: Optional[pd.DataFrame]

Evaluation set dataframes.

ratings: the computed ratings set. train: the train set or None when not needed for evaluation. test: the test set or None when not needed for evaluation.

EvaluationSets( ratings: pandas.core.frame.DataFrame, train: Optional[pandas.core.frame.DataFrame], test: Optional[pandas.core.frame.DataFrame])