recnexteval 0.1.0__py3-none-any.whl

recnexteval/utils/yaml_tool.py

@@ -0,0 +1,65 @@
+import os
+
+import yaml
+
+from .path import get_logs_dir, safe_dir
+
+
+def create_config_yaml(config_filename: str) -> tuple[str, str]:
+    """
+    Create a configuration file for the logger.
+
+    Writes a default configuration file for the logger in YAML format.
+    The configuration file specifies the format of the log messages,
+    the output stream, and the log level.
+
+    :param path: The name of the file to be created.
+    :type path: str
+    """
+    log_dir = get_logs_dir()
+    safe_dir(log_dir)
+    log_file_path = os.path.join(log_dir, "recnexteval.log")
+    yaml_file_path = os.path.join(log_dir, config_filename)
+
+    # check if log file and yaml file already exist
+    if os.path.exists(yaml_file_path) and os.path.exists(log_file_path):
+        return (log_file_path, yaml_file_path)
+
+    default_config = {
+        "version": 1,
+        "disable_existing_loggers": False,
+        "formatters": {
+            "detailed": {"format": "%(asctime)s - %(name)s - %(levelname)s - %(message)s"},
+            "simple": {"format": "%(levelname)s - %(message)s"},
+        },
+        "handlers": {
+            "console": {
+                "class": "logging.StreamHandler",
+                "level": "DEBUG",
+                "formatter": "simple",
+                "stream": "ext://sys.stdout",
+            },
+            "file": {
+                "class": "logging.FileHandler",
+                "level": "DEBUG",
+                "formatter": "detailed",
+                "filename": log_file_path,
+            },
+        },
+        "loggers": {
+            "recnexteval": {
+                "level": "DEBUG",
+                "handlers": ["console", "file"],
+                "propagate": False,
+            },
+        },
+        "root": {
+            "level": "WARNING",
+            "handlers": ["console"],
+        },
+    }
+
+    # Write the YAML content
+    with open(yaml_file_path, "w") as file:
+        yaml.dump(default_config, file, default_flow_style=False)
+    return (log_file_path, yaml_file_path)

recnexteval-0.1.0.dist-info/METADATA

@@ -0,0 +1,85 @@
+Metadata-Version: 2.3
+Name: recnexteval
+Version: 0.1.0
+Summary: An Evaluation Framework for Next-Batch Recommendations.
+Keywords: recsys,recommendation,practical evaluation,global timeline,reccomender systems,data leakage
+Author: Ng Tze Kean
+Author-email: Ng Tze Kean <ngtzekean@gmail.com>
+Requires-Dist: colorama>=0.4.6
+Requires-Dist: colorlog>=6.10.1
+Requires-Dist: deprecation>=2.1.0
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: numpy==2.2.6
+Requires-Dist: pandas>=2.3.3
+Requires-Dist: progressbar>=2.5
+Requires-Dist: pyarrow>=22.0.0
+Requires-Dist: pyfiglet>=1.0.4
+Requires-Dist: scikit-learn>=1.7.2
+Requires-Dist: scipy>=1.16.3
+Requires-Dist: simplejson>=3.20.2
+Requires-Dist: tqdm>=4.67.1
+Requires-Dist: typing-extensions>=4.15.0
+Requires-Dist: urllib3>=2.5.0
+Maintainer: Ng Tze Kean
+Maintainer-email: Ng Tze Kean <ngtzekean@gmail.com>
+Requires-Python: >=3.13
+Project-URL: Homepage, https://hiiamtzekean.github.io/recnexteval/
+Project-URL: Repository, https://github.com/ngtzekean/recnexteval
+Description-Content-Type: text/markdown
+
+# RecNextEval
+
+![recnexteval-logo](https://github.com/HiIAmTzeKean/recnexteval/raw/master/docs/assets/_static/logo_name.png)
+
+[![PyPI Latest Release](https://img.shields.io/pypi/v/recnexteval.svg)](https://pypi.org/project/recnexteval/)&nbsp;&nbsp;
+[![Docs](https://github.com/hiiamtzekean/recnexteval/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/hiiamtzekean/recnexteval/)&nbsp;&nbsp;
+[![Python version](https://img.shields.io/badge/python-3.12.5-blue)](https://www.python.org/downloads/)
+
+RecNextEval is an offline Reccomender Systems (RecSys) evaluation toolkit that respects a global timeline.
+The aim is to partition the data into different windows where data is incrementally released for the programmer
+to fit, train and submit predictions. This aims to provide a close simulation of an online setting when evaluating
+RecSys algorithms.
+
+## Getting Started
+
+Clone the repository
+
+```bash
+git clone https://github.com/hiiamtzekean/recnexteval
+cd recnexteval
+```
+
+Dependencies can be installed with `uv` for ease of management.
+
+```bash
+uv sync
+```
+
+Alternatively, you may install dependencies locally with pip and venv
+
+```bash
+python3 -m venv venv
+source venv/bin/activate
+pip install -e .
+```
+
+The dependencies are listed in `pyproject.toml`.
+
+## Contributing
+
+- We welcome all contributors, be it reporting an [issue](https://github.com/hiiamtzekean/recnexteval/issues),
+or raising a [pull request](https://github.com/hiiamtzekean/recnexteval/pulls) to fix an issue.
+- When you make changes, rerun `pip install .` to test your changes.
+
+## Documentation
+
+The documentation can be found [here](https://hiiamtzekean.github.io/recnexteval/)
+and [repository](https://github.com/hiiamtzekean/recnexteval) on Github.
+
+## Citation
+
+If you use this library in any part of your work, please cite the following papers:
+
+```text
+Ng, T. K. (2024). RecNextEval: a toolkit for offline evaluation of recommender systems. Final Year Project (FYP), Nanyang Technological University, Singapore. https://hdl.handle.net/10356/181114
+```

recnexteval-0.1.0.dist-info/RECORD

@@ -0,0 +1,110 @@
+recnexteval/__init__.py,sha256=QRo7Xnqfqul1DCK2q8Le8FWayQO8NIWhRvOXeCYUmpY,454
+recnexteval/algorithms/__init__.py,sha256=jZK-jo5-v8znxKM11LxrRX7TLM5XHR3BIDf-EazP5RM,2826
+recnexteval/algorithms/base.py,sha256=f5gDhYjeJNU9zYx2IyGUi5lm8y1sJ9Ko5g3f9DqSEkw,13986
+recnexteval/algorithms/baseline/__init__.py,sha256=1L-mIcgRcjX4yUdyTyKl95DWO6oh6zBHlcC8K__vqtE,186
+recnexteval/algorithms/baseline/decay_popularity.py,sha256=6Wl-87yKnRzVbk4-4j733lc0Qs6BcSFOZAmiz2uJ8-U,4099
+recnexteval/algorithms/baseline/most_popular.py,sha256=E0VomehN8P4bu4NVOfkeOQqqQ2iTvA5l3b1pthJyI20,2640
+recnexteval/algorithms/baseline/random.py,sha256=_otqjMwOCn25I8R3CHUqsbhjVZQYGvYwYdhz72lFh-4,1314
+recnexteval/algorithms/baseline/recent_popularity.py,sha256=Dls2PE23rfDC8hqIkI7C8WzAyHidSYK307_4Jok3GsM,1010
+recnexteval/algorithms/itemknn/__init__.py,sha256=6hqiXXgtwiO0HTXPei8HJSMKTgF9KMFCZggOmKJmr2E,381
+recnexteval/algorithms/itemknn/itemknn.py,sha256=YhfmcD5jYSz_w41Qp18CLPMd4bk7K5ZUmvbpQ2gxR2A,4294
+recnexteval/algorithms/itemknn/itemknn_incremental.py,sha256=gsmNcT6RFghXFfjL6PiVoyOZWFbwuP1Gj5cQHE6hc-I,2461
+recnexteval/algorithms/itemknn/itemknn_incremental_movielens.py,sha256=ZKwTpeRVLLioEKAPCuoDzegJk6p9_eBp9gPAOYPYYBw,3862
+recnexteval/algorithms/itemknn/itemknn_rolling.py,sha256=UDIDDZnrpTUz6edIShC0YSj0KncRHmcnn4K_MLwp_x4,416
+recnexteval/algorithms/itemknn/itemknn_static.py,sha256=Xupk8A_U8htQtoj43IcJGOcAaoslPw6CzOxqxmDzjB0,801
+recnexteval/algorithms/time_aware_item_knn/__init__.py,sha256=7xUQJHJ83SpZWjZ7snY6FI2Fa9v5W0U6SbW5duegl4g,552
+recnexteval/algorithms/time_aware_item_knn/base.py,sha256=IdwVHU5H_rTUgaMSqOL-SDQlda_bky9ZYVrUGuOJbUM,9921
+recnexteval/algorithms/time_aware_item_knn/decay_functions.py,sha256=mHhfNErg7tNYYlhO7DSohZHa182Qy6EB2tNI4Fs90_Y,8233
+recnexteval/algorithms/time_aware_item_knn/ding_2005.py,sha256=a7FY3c6G7WWnhm7h5bQURRXqRCvKTBpE512Kmh30xfQ,2425
+recnexteval/algorithms/time_aware_item_knn/liu_2010.py,sha256=GdDULJDqYJ7yI1THiumB3W0ETeGo5UadnFo3Zc589ZY,2731
+recnexteval/algorithms/time_aware_item_knn/similarity_functions.py,sha256=O79znB6i9WTi-cPsfpPjmKKwj5rdgzda9W_J2L7yfXU,3822
+recnexteval/algorithms/time_aware_item_knn/top_k.py,sha256=yFPDBj_pIDByiAy3kf5PGmp6n-49KrqFQPUzWhZY958,2110
+recnexteval/algorithms/time_aware_item_knn/utils.py,sha256=mmdiBeJKztPN6OUQlk2lBFYkmNwEn3qElkrsfcSyXRk,1138
+recnexteval/algorithms/time_aware_item_knn/vaz_2013.py,sha256=F5KbKbXvYgTmN0VtbbkJR9HmjjuNL9sgaDvogJlMyoM,2355
+recnexteval/algorithms/utils.py,sha256=aN-riaDv_s7FRX4SYiXvdvr4k87vxduPEY0CrNXj7Fo,1932
+recnexteval/datasets/__init__.py,sha256=F_zZxJQlXk4X6Rpqem-NB00y3TqdOh2MbdufKhGz7RA,3020
+recnexteval/datasets/base.py,sha256=Q1HN-l5mdO_HwcSWIUGo7OvUsa2pPWNjzAhltWO20pM,11725
+recnexteval/datasets/config/__init__.py,sha256=ncRGMFWK-7Ug4zoWyu91wl0-YCDKVj4H1idBhz1SEZE,3847
+recnexteval/datasets/config/amazon.py,sha256=kgLpGzkeq2MaEVYkVTDe5pBU5Uhfz5J51Im5aaiVmAY,6534
+recnexteval/datasets/config/base.py,sha256=RI9ZIVjFv96E_oqIni1cAFkuk_qD50NutqdYMBKFsis,2145
+recnexteval/datasets/config/lastfm.py,sha256=ky92tMDgPZw9BOyO4a8uZcS7TVbiH979EnYULV6p9xg,3040
+recnexteval/datasets/config/movielens.py,sha256=PtsxJi8XvtjfVoDZ_PPfuSAYajKOCi5gheB4iMp2-Wo,5040
+recnexteval/datasets/config/yelp.py,sha256=dqQz1moQFvawqWSPrtNwkaXzEGw5KysCt_GDqyFB11A,797
+recnexteval/datasets/datasets/__init__.py,sha256=x-niCQWm5qUNCxbkdmM9anS3RizJLd9f0Hyy-oge07E,514
+recnexteval/datasets/datasets/amazon.py,sha256=SUHpIgoUufUGuYOs6qybUcMmHlu-kcw3VzHrkbhoGCI,4553
+recnexteval/datasets/datasets/base.py,sha256=iXM6u_l8VugQLEf1HVjatASrOAD4ZxouWDBc8Gvd-BA,9333
+recnexteval/datasets/datasets/lastfm.py,sha256=8X0nm0QKu3aBIMFyNbSY9qBcsHbE_LdvuAD0psR3huY,4313
+recnexteval/datasets/datasets/movielens.py,sha256=QzneJ_JxwrSveuK1iMx9N2L2DP0wzpktM4ejh_54NNE,2918
+recnexteval/datasets/datasets/test.py,sha256=vOL3DjkeMf6I1yEDv1nlxl2SPLg7-typwkH9L2Bhoc8,1576
+recnexteval/datasets/datasets/yelp.py,sha256=W6J4i1gDBXBuuIICI_OgB9bAOa-9-xMWpYWO80M4z3s,3539
+recnexteval/datasets/metadata/__init__.py,sha256=j_UgDXPATybSUkeL958hzaRZpfNuQ0GgHrTv7KysQzo,1899
+recnexteval/datasets/metadata/amazon.py,sha256=Is2PWTzv-awVfi433EsqlRJ_yluqkp9zvrwO6UG4avo,2274
+recnexteval/datasets/metadata/base.py,sha256=olHnYb0Lg9mTKjaEoHDCk0Iq6twN1xwisBtPCkcxneg,1154
+recnexteval/datasets/metadata/lastfm.py,sha256=H0YxTz5-mC9RDTmq_Z2Nu_ys9nRkxtUPf_lt8GT6mNc,3402
+recnexteval/datasets/metadata/movielens.py,sha256=w-VQgwjTSgcIyaCdQKssKuL-Q8QKnW5rD8sj_J-AZK0,2909
+recnexteval/evaluators/__init__.py,sha256=is_7giST5MMOWixXR4pu7OHvVMjEdPkZ43Lxyihff5A,5895
+recnexteval/evaluators/accumulator.py,sha256=hWSsSeQ8YtQgRFukh4dcE_rl02qe8rGsGEFf6_Zb9xg,6617
+recnexteval/evaluators/base.py,sha256=9L1o2Glm2kNkJute9RGPDnZwUyweMnofTFebeSXOFg0,8979
+recnexteval/evaluators/builder/__init__.py,sha256=MHHPoD61TIdLG9MdsQrLl3hl8Fwsulqhopa7KVTFE_k,3491
+recnexteval/evaluators/builder/base.py,sha256=QaGu_HumkEe-2TRmYxTIQI1PdVj1xNLw3u8GjO1x5AA,5806
+recnexteval/evaluators/builder/pipeline.py,sha256=GrqenqXGn5CAqGdiCPeaxqSFWmC8iQRol8AgL9Jr4tk,3883
+recnexteval/evaluators/builder/stream.py,sha256=rc9EbZOfpwh4fiMXp3Z92p4nZArss1JdeVNTIU7GQ0U,1671
+recnexteval/evaluators/evaluator_pipeline.py,sha256=P7NcIeXlrOsifILXF2-AA6PcTDCyZupEuuQ7Y7QPZpQ,11918
+recnexteval/evaluators/evaluator_stream.py,sha256=iAO6xKN3qrb-zHanA7q1TcOUtEX7_kjIzawu1spbtIs,15616
+recnexteval/evaluators/state_management.py,sha256=VuD6glygVhlA3uM1qCBopcqYtnDCzjMmcO4PfKBvzR0,11439
+recnexteval/evaluators/strategy.py,sha256=QxnMDf_x9LF9oVNUgrw1YiED8faZSzCyb3p__Sn1Ebo,1207
+recnexteval/evaluators/util.py,sha256=VnZdxdmuBbyGI706JYhL2kVdVhWvgpIE_U2FEgGO3bY,3972
+recnexteval/matrix/__init__.py,sha256=WFQXFNlATvlLgJxd6GtTRa_pJPRjAedl-YHWckovC-4,2178
+recnexteval/matrix/exception.py,sha256=qGkANmmUP33y0Qt9GXwiLgOSPOlUR4lZ2oQkP7s0c5E,235
+recnexteval/matrix/interaction_matrix.py,sha256=HWmFUwkbIlZXgYbPDAo5CL-ErbI7X01YZS2RCu-1NFY,31314
+recnexteval/matrix/prediction_matrix.py,sha256=SqR_XgWvItXDwycIsFEzFaqECiEWIEOaGxeibJ9aIZ4,6961
+recnexteval/matrix/util.py,sha256=7Qelrr1aFm0j98-WkyzF2ZPaEtcVEzDimHcgcS1HFr8,844
+recnexteval/metrics/__init__.py,sha256=7DvIOt1LYarUeXwH3zWsZbN-WknKLFeKUy1FHEZuAds,1532
+recnexteval/metrics/binary/__init__.py,sha256=7Z9M0ncgzhcza_yT6PnH8oA2tHHED4jJfsV11KScYus,43
+recnexteval/metrics/binary/hit.py,sha256=xX2rQ_QfOKGBiV5psFBHGofBRkwf0Nw0ljTWH_aS79k,1648
+recnexteval/metrics/core/__init__.py,sha256=GrUfOV6ZhC68s2zuUtH08Rdbc7HAQkim72ZaUE7TaAA,170
+recnexteval/metrics/core/base.py,sha256=vXoQ4xnNlH8twaY2JPh0bancCOnC4lPY41FCnRe46U0,4309
+recnexteval/metrics/core/elementwise_top_k.py,sha256=pyjcF3rmHhia1AH5syV6x7j0lmpkazWD4jMksEyD4bs,2560
+recnexteval/metrics/core/listwise_top_k.py,sha256=yc-553k2E0SiVL1wkQ167JLIAw7vxB14S5kayz2s4fw,2394
+recnexteval/metrics/core/top_k.py,sha256=KjJFWwO-CyhBePXmSrHFe9DOg6Uc0m9fSt5KVeVS-tc,1841
+recnexteval/metrics/core/util.py,sha256=xBl6pCRWJ8K_lP4iCrBv0o3NP0x_kZFXIVD-kZlohmU,852
+recnexteval/metrics/ranking/__init__.py,sha256=hZYIL6d1vbKPwJdDYp-digtoSH4KVexLm9pRYjbQiOw,137
+recnexteval/metrics/ranking/dcg.py,sha256=Z69yUxmh5-Rg3FT2g5d-l273oziojsVd32N4HMLKTOM,1775
+recnexteval/metrics/ranking/ndcg.py,sha256=E-fkzpFRyUjf_CEkj-iRY1ekLVa2ieJwnh2a5Hajwkk,2592
+recnexteval/metrics/ranking/precision.py,sha256=xRkXhL-2bZDCTR833s60qjFo3EYVGJM0etCF9rrk0Vs,1728
+recnexteval/metrics/ranking/recall.py,sha256=fjaN1QRWY0GyeUV9S14mnFBhj4PDQ_MJwZcQj0bgblY,1307
+recnexteval/models/__init__.py,sha256=QBe1epPRZoznMS02wVUQ71P7eQ4_E9IsbhNu-pp2GrU,80
+recnexteval/models/base.py,sha256=yUCApLqMfrhohIr-TgGvDkfJAUMnr8kLSaQxSR__t9w,1688
+recnexteval/preprocessing/__init__.py,sha256=RaiCM2mkuOae55dVGMJuI-JBJL1FWCO5EbdJg__MPr0,1176
+recnexteval/preprocessing/filter.py,sha256=EME-cvde8AhAchqObySHv2LHRVxK4wf146EMc4Tn6w0,4845
+recnexteval/preprocessing/preprocessor.py,sha256=PFZy51dOnpBIeTEsZ7cWh8W49frknebmvxT3RASpZok,5012
+recnexteval/registries/__init__.py,sha256=PrFnje4-qEBIFecVmKLB1mBI3GBbGfdlseXBfAy4cE8,1805
+recnexteval/registries/algorithm.py,sha256=OuPEnS4mP_90Nr8Da9AjoYKTuByrPnd5565Gzb0-MVI,1962
+recnexteval/registries/base.py,sha256=GM4SvxwcHxfJNwLm-CN2NZV5ZNoWZGYLNReHVzYicGA,3951
+recnexteval/registries/dataset.py,sha256=c-TXAkwX_VH5Z10ZNdfSmU7yU-QA1j_HpCxBUCp3rro,969
+recnexteval/registries/metric.py,sha256=jf6Dzu6CdawFkIJZDNtYj_is7eI0U5WlfctLgMBPJpk,1442
+recnexteval/settings/__init__.py,sha256=CCssGfvK2KOFhofUPXwHK5iHlrqX_NmAeGfhsL3q-2Y,4548
+recnexteval/settings/base.py,sha256=JXD0KVsSWcFz2Hhh2hvVB2XdgCrA8Q_H_T8riCN4ON4,15844
+recnexteval/settings/exception.py,sha256=JAMR87gdAtmsOxcfHgPi80nppC90Ip_49rExyaEYcSE,295
+recnexteval/settings/leave_n_out_setting.py,sha256=pIfJI2trLB18g-eXECCk-qsjLtQjgLIVSFn22_m7ME0,1425
+recnexteval/settings/processor.py,sha256=BUjKaAPF4lpdYvR5B4PIPpmRQ-18yegEpGxkG2Pvmn0,4991
+recnexteval/settings/schema.py,sha256=a-fNMgBsoc8ePECHsHaB_SFn8fhxS7xMRXJbVdiPQvI,295
+recnexteval/settings/single_time_point_setting.py,sha256=-RmWXYnmLX4nEyaGwDTPPrewcjZstrIZMjgWWRXKXf0,4271
+recnexteval/settings/sliding_window_setting.py,sha256=KaWQSq_6FuwPuOzJMNI5pzjJM7h8_rHzfUfVAsavznA,6762
+recnexteval/settings/splitters/__init__.py,sha256=aPH1yR2n9RjKm6MbBBvBE3fc42JXqjBIXmiTRWqBRwg,309
+recnexteval/settings/splitters/base.py,sha256=WFXVh1Kv58HindPIKSTnuL3qgD95pi75r4I7vjhJfF4,1638
+recnexteval/settings/splitters/n_last.py,sha256=YOxL8_rhCLMWG1EBm9Bu9eLARE4VSIid1o86LXleX4E,1435
+recnexteval/settings/splitters/n_last_timestamp.py,sha256=tP_GiVEPd80Rpv7migiHgFF7RHUeigfLHOyrkCzobA8,2961
+recnexteval/settings/splitters/timestamp.py,sha256=29s3-vl_0mmhDqNUv2clblnUIBvc5hK2hc2YEvNmSc0,2842
+recnexteval/settings/util.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+recnexteval/utils/__init__.py,sha256=6jHBaGkQc0NbBWXfE-FETN-mJtnysWCztoaJxp5w9bk,2930
+recnexteval/utils/json_to_csv_converter.py,sha256=6vo0tbZDDhtvk6YCVMFRtLeUhiSkGdSjtW6zoDhTfvo,3665
+recnexteval/utils/logging_tools.py,sha256=jDVwyWPJWZ4Ztmbx-k1G6dF2AmcqbBzdgzWWDZgKKxw,4438
+recnexteval/utils/path.py,sha256=v2e5PNaohnwQtRq8oU-RI5IVhquxAG2G3e2cvr0xPjE,4260
+recnexteval/utils/url_certificate_installer.py,sha256=wSK7hgcZRitUqHfXjgeeBdHWz6__tc78i8i4lMwckSY,1506
+recnexteval/utils/util.py,sha256=B76Z-SSNeqwUWJavkl2xsTkFhfsicmCCnF6OZMzTyg0,4836
+recnexteval/utils/uuid_util.py,sha256=WA7PfCdULyUnCDs0FXpi2S7pSwTTLn0SQpkAqUAcKTE,262
+recnexteval/utils/yaml_tool.py,sha256=VgN-T0OVRfp5Ie3XCDyuIcg2VLQBM-JIks-mgPfDbUQ,2006
+recnexteval-0.1.0.dist-info/WHEEL,sha256=XV0cjMrO7zXhVAIyyc8aFf1VjZ33Fen4IiJk5zFlC3g,80
+recnexteval-0.1.0.dist-info/METADATA,sha256=slhKsG8ewdOPB0pw6ErCyyBySUaU2LCoXvoX9V5MkzY,3097
+recnexteval-0.1.0.dist-info/RECORD,,

recnexteval-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.9.26
+Root-Is-Purelib: true
+Tag: py3-none-any