replay-rec 0.18.1__tar.gz → 0.18.1rc0__tar.gz

replay_rec-0.18.1rc0/NOTICE

@@ -0,0 +1,41 @@
+Apache Spark
+Copyright 2014 and onwards The Apache Software Foundation.
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
+
+
+Export Control Notice
+---------------------
+
+This distribution includes cryptographic software. The country in which you currently reside may have
+restrictions on the import, possession, use, and/or re-export to another country, of encryption software.
+BEFORE using any encryption software, please check your country's laws, regulations and policies concerning
+the import, possession, or use, and re-export of encryption software, to see if this is permitted. See
+<http://www.wassenaar.org/> for more information.
+
+The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this
+software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software
+using or performing cryptographic functions with asymmetric algorithms. The form and manner of this Apache
+Software Foundation distribution makes it eligible for export under the License Exception ENC Technology
+Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for
+both object code and source code.
+
+The following provides more details on the included cryptographic software:
+
+This software uses Apache Commons Crypto (https://commons.apache.org/proper/commons-crypto/) to
+support authentication, and encryption and decryption of data sent across the network between
+services.
+
+
+Metrics
+Copyright 2010-2013 Coda Hale and Yammer, Inc.
+
+This product includes software developed by Coda Hale and Yammer, Inc.
+
+This product includes code derived from the JSR-166 project (ThreadLocalRandom, Striped64,
+LongAdder), which was released with the following comments:
+
+    Written by Doug Lea with assistance from members of JCP JSR-166
+    Expert Group and released to the public domain, as explained at
+    http://creativecommons.org/publicdomain/zero/1.0/

{replay_rec-0.18.1 → replay_rec-0.18.1rc0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: replay-rec
-Version: 0.18.1
+Version: 0.18.1rc0
 Summary: RecSys Library
 Home-page: https://sb-ai-lab.github.io/RePlay/
 License: Apache-2.0
@@ -22,9 +22,16 @@ Provides-Extra: all
 Provides-Extra: spark
 Provides-Extra: torch
 Provides-Extra: torch-openvino
+Requires-Dist: d3rlpy (>=2.0.4,<3.0.0)
 Requires-Dist: fixed-install-nmslib (==2.1.2)
+Requires-Dist: gym (>=0.26.0,<0.27.0)
 Requires-Dist: hnswlib (>=0.7.0,<0.8.0)
+Requires-Dist: implicit (>=0.7.0,<0.8.0)
+Requires-Dist: lightautoml (>=0.3.1,<0.4.0)
+Requires-Dist: lightfm (==1.17)
 Requires-Dist: lightning (>=2.0.2,<=2.4.0) ; extra == "torch" or extra == "torch-openvino" or extra == "all"
+Requires-Dist: llvmlite (>=0.32.1)
+Requires-Dist: numba (>=0.50)
 Requires-Dist: numpy (>=1.20.0)
 Requires-Dist: onnx (>=1.16.2,<1.17.0) ; extra == "torch-openvino" or extra == "all"
 Requires-Dist: openvino (>=2024.3.0,<2024.4.0) ; extra == "torch-openvino" or extra == "all"
@@ -33,12 +40,13 @@ Requires-Dist: pandas (>=1.3.5,<=2.2.2)
 Requires-Dist: polars (>=1.0.0,<1.1.0)
 Requires-Dist: psutil (>=6.0.0,<6.1.0)
 Requires-Dist: pyarrow (>=12.0.1)
-Requires-Dist: pyspark (>=3.0,<3.6) ; (python_full_version >= "3.8.1" and python_version < "3.11") and (extra == "spark" or extra == "all")
-Requires-Dist: pyspark (>=3.4,<3.6) ; (python_version >= "3.11" and python_version < "3.12") and (extra == "spark" or extra == "all")
+Requires-Dist: pyspark (>=3.0,<3.5) ; (python_full_version >= "3.8.1" and python_version < "3.11") and (extra == "spark" or extra == "all")
+Requires-Dist: pyspark (>=3.4,<3.5) ; (python_version >= "3.11" and python_version < "3.12") and (extra == "spark" or extra == "all")
 Requires-Dist: pytorch-ranger (>=0.1.1,<0.2.0) ; extra == "torch" or extra == "torch-openvino" or extra == "all"
+Requires-Dist: sb-obp (>=0.5.8,<0.6.0)
 Requires-Dist: scikit-learn (>=1.0.2,<2.0.0)
 Requires-Dist: scipy (>=1.8.1,<2.0.0)
-Requires-Dist: torch (>=1.8,<=2.5.0) ; extra == "torch" or extra == "torch-openvino" or extra == "all"
+Requires-Dist: torch (>=1.8,<=2.4.0) ; extra == "torch" or extra == "torch-openvino" or extra == "all"
 Project-URL: Repository, https://github.com/sb-ai-lab/RePlay
 Description-Content-Type: text/markdown
 

{replay_rec-0.18.1 → replay_rec-0.18.1rc0}/pyproject.toml

@@ -39,9 +39,8 @@ classifiers = [
 ]
 exclude = [
     "replay/conftest.py",
-    "replay/experimental",
 ]
-version = "0.18.1"
+version = "0.18.1.preview"
 
 [tool.poetry.dependencies]
 python = ">=3.8.1, <3.12"
@@ -55,15 +54,23 @@ scikit-learn = "^1.0.2"
 pyarrow = ">=12.0.1"
 openvino = {version = "~2024.3.0", optional = true}
 onnx = {version = "~1.16.2", optional = true}
-pyspark = [
-    {version = ">=3.4,<3.6", python = ">=3.11,<3.12", optional = true},
-    {version = ">=3.0,<3.6", python = ">=3.8.1,<3.11", optional = true},
-]
-torch = {version = ">=1.8, <=2.5.0", optional = true}
-lightning = {version = ">=2.0.2, <=2.4.0", optional = true}
-pytorch-ranger = {version = "^0.1.1", optional = true}
 fixed-install-nmslib = "2.1.2"
 hnswlib = "^0.7.0"
+pyspark = [
+    {version = ">=3.4,<3.5", python = ">=3.11,<3.12"},
+    {version = ">=3.0,<3.5", python = ">=3.8.1,<3.11"},
+]
+torch = ">=1.8, <=2.4.0"
+lightning = ">=2.0.2, <=2.4.0"
+pytorch-ranger = "^0.1.1"
+lightfm = "1.17"
+lightautoml = "~0.3.1"
+numba = ">=0.50"
+llvmlite = ">=0.32.1"
+sb-obp = "^0.5.8"
+d3rlpy = "^2.0.4"
+implicit = "~0.7.0"
+gym = "^0.26.0"
 
 [tool.poetry.extras]
 spark = ["pyspark"]

replay_rec-0.18.1rc0/replay/__init__.py

@@ -0,0 +1,3 @@
+""" RecSys library """
+
+__version__ = "0.18.1.preview"

replay_rec-0.18.1rc0/replay/experimental/metrics/__init__.py

@@ -0,0 +1,62 @@
+"""
+Most metrics require dataframe with recommendations
+and dataframe with ground truth values —
+which objects each user interacted with.
+
+- recommendations (Union[pandas.DataFrame, spark.DataFrame]):
+    predictions of a recommender system,
+    DataFrame with columns ``[user_id, item_id, relevance]``
+- ground_truth (Union[pandas.DataFrame, spark.DataFrame]):
+    test data, DataFrame with columns
+    ``[user_id, item_id, timestamp, relevance]``
+
+Metric is calculated for all users, presented in ``ground_truth``
+for accurate metric calculation in case when the recommender system generated
+recommendation not for all users.  It is assumed, that all users,
+we want to calculate metric for, have positive interactions.
+
+But if we have users, who observed the recommendations, but have not responded,
+those users will be ignored and metric will be overestimated.
+For such case we propose additional optional parameter ``ground_truth_users``,
+the dataframe with all users, which should be considered during the metric calculation.
+
+- ground_truth_users (Optional[Union[pandas.DataFrame, spark.DataFrame]]):
+    full list of users to calculate metric for, DataFrame with ``user_id`` column
+
+Every metric is calculated using top ``K`` items for each user.
+It is also possible to calculate metrics
+using multiple values for ``K`` simultaneously.
+In this case the result will be a dictionary and not a number.
+
+Make sure your recommendations do not contain user-item duplicates
+as duplicates could lead to the wrong calculation results.
+
+- k (Union[Iterable[int], int]):
+    a single number or a list, specifying the
+    truncation length for recommendation list for each user
+
+By default, metrics are averaged by users,
+but you can alternatively use method ``metric.median``.
+Also, you can get the lower bound
+of ``conf_interval`` for a given ``alpha``.
+
+Diversity metrics require extra parameters on initialization stage,
+but do not use ``ground_truth`` parameter.
+
+For each metric, a formula for its calculation is given, because this is
+important for the correct comparison of algorithms, as mentioned in our
+`article <https://arxiv.org/abs/2206.12858>`_.
+"""
+
+from replay.experimental.metrics.base_metric import Metric, NCISMetric
+from replay.experimental.metrics.coverage import Coverage
+from replay.experimental.metrics.hitrate import HitRate
+from replay.experimental.metrics.map import MAP
+from replay.experimental.metrics.mrr import MRR
+from replay.experimental.metrics.ncis_precision import NCISPrecision
+from replay.experimental.metrics.ndcg import NDCG
+from replay.experimental.metrics.precision import Precision
+from replay.experimental.metrics.recall import Recall
+from replay.experimental.metrics.rocauc import RocAuc
+from replay.experimental.metrics.surprisal import Surprisal
+from replay.experimental.metrics.unexpectedness import Unexpectedness