Update documentation

recommenders-team · Sep 11, 2024 · 04724b8 · 04724b8
1 parent 0ab3dd8
commit 04724b8
Show file tree

Hide file tree

Showing 9 changed files with 85 additions and 46 deletions.
diff --git a/_modules/recommenders/datasets/mind.html b/_modules/recommenders/datasets/mind.html
@@ -348,26 +348,37 @@ <h1>Source code for recommenders.datasets.mind</h1><div class="highlight"><pre>
 <span class="p">)</span>
 
 
-<span class="n">URL_MIND_LARGE_TRAIN</span> <span class="o">=</span> <span class="p">(</span>
-    <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDlarge_train.zip&quot;</span>
+<span class="n">URL_MIND_DEMO_TRAIN</span> <span class="o">=</span> <span class="p">(</span>
+    <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDdemo_train.zip&quot;</span>
 <span class="p">)</span>
-<span class="n">URL_MIND_LARGE_VALID</span> <span class="o">=</span> <span class="p">(</span>
-    <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDlarge_dev.zip&quot;</span>
+<span class="n">URL_MIND_DEMO_VALID</span> <span class="o">=</span> <span class="p">(</span>
+    <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDdemo_dev.zip&quot;</span>
+<span class="p">)</span>
+<span class="n">URL_MIND_DEMO_UTILS</span> <span class="o">=</span> <span class="p">(</span>
+    <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDdemo_utils.zip&quot;</span>
 <span class="p">)</span>
+
 <span class="n">URL_MIND_SMALL_TRAIN</span> <span class="o">=</span> <span class="p">(</span>
     <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDsmall_train.zip&quot;</span>
 <span class="p">)</span>
 <span class="n">URL_MIND_SMALL_VALID</span> <span class="o">=</span> <span class="p">(</span>
     <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDsmall_dev.zip&quot;</span>
 <span class="p">)</span>
-<span class="n">URL_MIND_DEMO_TRAIN</span> <span class="o">=</span> <span class="p">(</span>
-    <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDdemo_train.zip&quot;</span>
+<span class="n">URL_MIND_SMALL_UTILS</span> <span class="o">=</span> <span class="p">(</span>
+    <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDsmall_utils.zip&quot;</span>
 <span class="p">)</span>
-<span class="n">URL_MIND_DEMO_VALID</span> <span class="o">=</span> <span class="p">(</span>
-    <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDdemo_dev.zip&quot;</span>
+
+<span class="n">URL_MIND_LARGE_TRAIN</span> <span class="o">=</span> <span class="p">(</span>
+    <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDlarge_train.zip&quot;</span>
 <span class="p">)</span>
-<span class="n">URL_MIND_DEMO_UTILS</span> <span class="o">=</span> <span class="p">(</span>
-    <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDdemo_utils.zip&quot;</span>
+<span class="n">URL_MIND_LARGE_VALID</span> <span class="o">=</span> <span class="p">(</span>
+    <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDlarge_dev.zip&quot;</span>
+<span class="p">)</span>
+<span class="n">URL_MIND_LARGE_TEST</span> <span class="o">=</span> <span class="p">(</span>
+    <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDlarge_test.zip&quot;</span>
+<span class="p">)</span>
+<span class="n">URL_MIND_LARGE_UTILS</span> <span class="o">=</span> <span class="p">(</span>
+    <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDlarge_utils.zip&quot;</span>
 <span class="p">)</span>
 
 <span class="n">URL_MIND</span> <span class="o">=</span> <span class="p">{</span>

diff --git a/_modules/recommenders/models/deeprec/DataModel/ImplicitCF.html b/_modules/recommenders/models/deeprec/DataModel/ImplicitCF.html
@@ -550,6 +550,8 @@ <h1>Source code for recommenders.models.deeprec.DataModel.ImplicitCF</h1><div cl
 <span class="sd">        &quot;&quot;&quot;</span>
 
         <span class="k">def</span> <span class="nf">sample_neg</span><span class="p">(</span><span class="n">x</span><span class="p">):</span>
+            <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">&gt;=</span> <span class="bp">self</span><span class="o">.</span><span class="n">n_items</span><span class="p">:</span>
+                <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;A user has voted in every item. Can&#39;t find a negative sample.&quot;</span><span class="p">)</span>
             <span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
                 <span class="n">neg_id</span> <span class="o">=</span> <span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">n_items</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
                 <span class="k">if</span> <span class="n">neg_id</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">x</span><span class="p">:</span>

diff --git a/build/lib/recommenders/datasets/mind.py b/build/lib/recommenders/datasets/mind.py
@@ -17,26 +17,37 @@
 )
 
 
-URL_MIND_LARGE_TRAIN = (
-    "https://recodatasets.z20.web.core.windows.net/newsrec/MINDlarge_train.zip"
+URL_MIND_DEMO_TRAIN = (
+    "https://recodatasets.z20.web.core.windows.net/newsrec/MINDdemo_train.zip"
 )
-URL_MIND_LARGE_VALID = (
-    "https://recodatasets.z20.web.core.windows.net/newsrec/MINDlarge_dev.zip"
+URL_MIND_DEMO_VALID = (
+    "https://recodatasets.z20.web.core.windows.net/newsrec/MINDdemo_dev.zip"
+)
+URL_MIND_DEMO_UTILS = (
+    "https://recodatasets.z20.web.core.windows.net/newsrec/MINDdemo_utils.zip"
 )
+
 URL_MIND_SMALL_TRAIN = (
     "https://recodatasets.z20.web.core.windows.net/newsrec/MINDsmall_train.zip"
 )
 URL_MIND_SMALL_VALID = (
     "https://recodatasets.z20.web.core.windows.net/newsrec/MINDsmall_dev.zip"
 )
-URL_MIND_DEMO_TRAIN = (
-    "https://recodatasets.z20.web.core.windows.net/newsrec/MINDdemo_train.zip"
+URL_MIND_SMALL_UTILS = (
+    "https://recodatasets.z20.web.core.windows.net/newsrec/MINDsmall_utils.zip"
 )
-URL_MIND_DEMO_VALID = (
-    "https://recodatasets.z20.web.core.windows.net/newsrec/MINDdemo_dev.zip"
+
+URL_MIND_LARGE_TRAIN = (
+    "https://recodatasets.z20.web.core.windows.net/newsrec/MINDlarge_train.zip"
 )
-URL_MIND_DEMO_UTILS = (
-    "https://recodatasets.z20.web.core.windows.net/newsrec/MINDdemo_utils.zip"
+URL_MIND_LARGE_VALID = (
+    "https://recodatasets.z20.web.core.windows.net/newsrec/MINDlarge_dev.zip"
+)
+URL_MIND_LARGE_TEST = (
+    "https://recodatasets.z20.web.core.windows.net/newsrec/MINDlarge_test.zip"
+)
+URL_MIND_LARGE_UTILS = (
+    "https://recodatasets.z20.web.core.windows.net/newsrec/MINDlarge_utils.zip"
 )
 
 URL_MIND = {

diff --git a/build/lib/recommenders/models/deeprec/DataModel/ImplicitCF.py b/build/lib/recommenders/models/deeprec/DataModel/ImplicitCF.py
@@ -206,6 +206,8 @@ def train_loader(self, batch_size):
         """
 
         def sample_neg(x):
+            if len(x) >= self.n_items:
+                raise ValueError("A user has voted in every item. Can't find a negative sample.")
             while True:
                 neg_id = random.randint(0, self.n_items - 1)
                 if neg_id not in x:

diff --git a/docs/_build/html/.doctrees/environment.pickle b/docs/_build/html/.doctrees/environment.pickle
diff --git a/docs/_build/html/_modules/recommenders/datasets/mind.html b/docs/_build/html/_modules/recommenders/datasets/mind.html
@@ -348,26 +348,37 @@ <h1>Source code for recommenders.datasets.mind</h1><div class="highlight"><pre>
 <span class="p">)</span>
 
 
-<span class="n">URL_MIND_LARGE_TRAIN</span> <span class="o">=</span> <span class="p">(</span>
-    <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDlarge_train.zip&quot;</span>
+<span class="n">URL_MIND_DEMO_TRAIN</span> <span class="o">=</span> <span class="p">(</span>
+    <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDdemo_train.zip&quot;</span>
 <span class="p">)</span>
-<span class="n">URL_MIND_LARGE_VALID</span> <span class="o">=</span> <span class="p">(</span>
-    <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDlarge_dev.zip&quot;</span>
+<span class="n">URL_MIND_DEMO_VALID</span> <span class="o">=</span> <span class="p">(</span>
+    <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDdemo_dev.zip&quot;</span>
+<span class="p">)</span>
+<span class="n">URL_MIND_DEMO_UTILS</span> <span class="o">=</span> <span class="p">(</span>
+    <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDdemo_utils.zip&quot;</span>
 <span class="p">)</span>
+
 <span class="n">URL_MIND_SMALL_TRAIN</span> <span class="o">=</span> <span class="p">(</span>
     <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDsmall_train.zip&quot;</span>
 <span class="p">)</span>
 <span class="n">URL_MIND_SMALL_VALID</span> <span class="o">=</span> <span class="p">(</span>
     <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDsmall_dev.zip&quot;</span>
 <span class="p">)</span>
-<span class="n">URL_MIND_DEMO_TRAIN</span> <span class="o">=</span> <span class="p">(</span>
-    <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDdemo_train.zip&quot;</span>
+<span class="n">URL_MIND_SMALL_UTILS</span> <span class="o">=</span> <span class="p">(</span>
+    <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDsmall_utils.zip&quot;</span>
 <span class="p">)</span>
-<span class="n">URL_MIND_DEMO_VALID</span> <span class="o">=</span> <span class="p">(</span>
-    <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDdemo_dev.zip&quot;</span>
+
+<span class="n">URL_MIND_LARGE_TRAIN</span> <span class="o">=</span> <span class="p">(</span>
+    <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDlarge_train.zip&quot;</span>
 <span class="p">)</span>
-<span class="n">URL_MIND_DEMO_UTILS</span> <span class="o">=</span> <span class="p">(</span>
-    <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDdemo_utils.zip&quot;</span>
+<span class="n">URL_MIND_LARGE_VALID</span> <span class="o">=</span> <span class="p">(</span>
+    <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDlarge_dev.zip&quot;</span>
+<span class="p">)</span>
+<span class="n">URL_MIND_LARGE_TEST</span> <span class="o">=</span> <span class="p">(</span>
+    <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDlarge_test.zip&quot;</span>
+<span class="p">)</span>
+<span class="n">URL_MIND_LARGE_UTILS</span> <span class="o">=</span> <span class="p">(</span>
+    <span class="s2">&quot;https://recodatasets.z20.web.core.windows.net/newsrec/MINDlarge_utils.zip&quot;</span>
 <span class="p">)</span>
 
 <span class="n">URL_MIND</span> <span class="o">=</span> <span class="p">{</span>

diff --git a/docs/_build/html/_modules/recommenders/models/deeprec/DataModel/ImplicitCF.html b/docs/_build/html/_modules/recommenders/models/deeprec/DataModel/ImplicitCF.html
@@ -550,6 +550,8 @@ <h1>Source code for recommenders.models.deeprec.DataModel.ImplicitCF</h1><div cl
 <span class="sd">        &quot;&quot;&quot;</span>
 
         <span class="k">def</span> <span class="nf">sample_neg</span><span class="p">(</span><span class="n">x</span><span class="p">):</span>
+            <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o">&gt;=</span> <span class="bp">self</span><span class="o">.</span><span class="n">n_items</span><span class="p">:</span>
+                <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;A user has voted in every item. Can&#39;t find a negative sample.&quot;</span><span class="p">)</span>
             <span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
                 <span class="n">neg_id</span> <span class="o">=</span> <span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">n_items</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span>
                 <span class="k">if</span> <span class="n">neg_id</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">x</span><span class="p">:</span>

diff --git a/recommenders.egg-info/PKG-INFO b/recommenders.egg-info/PKG-INFO
@@ -58,17 +58,17 @@ Requires-Dist: pytest>=7.2.1; extra == "dev"
 Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
 Requires-Dist: pytest-mock>=3.10.0; extra == "dev"
 Provides-Extra: all
-Requires-Dist: pyspark<=4,>=3.3.0; extra == "all"
-Requires-Dist: tf-slim>=1.1.0; extra == "all"
-Requires-Dist: pyarrow>=10.0.1; extra == "all"
-Requires-Dist: pytest-mock>=3.10.0; extra == "all"
+Requires-Dist: torch<3,>=2.0.1; extra == "all"
 Requires-Dist: nvidia-ml-py>=11.525.84; extra == "all"
-Requires-Dist: tensorflow!=2.10.0.*,!=2.9.0.*,!=2.9.1,!=2.9.2,<2.16,>=2.8.4; extra == "all"
-Requires-Dist: fastai<3,>=2.7.11; extra == "all"
-Requires-Dist: pytest-cov>=4.1.0; extra == "all"
 Requires-Dist: black>=23.3.0; extra == "all"
+Requires-Dist: pytest-cov>=4.1.0; extra == "all"
+Requires-Dist: tensorflow!=2.10.0.*,!=2.9.0.*,!=2.9.1,!=2.9.2,<2.16,>=2.8.4; extra == "all"
+Requires-Dist: pytest-mock>=3.10.0; extra == "all"
+Requires-Dist: pyarrow>=10.0.1; extra == "all"
+Requires-Dist: tf-slim>=1.1.0; extra == "all"
 Requires-Dist: pytest>=7.2.1; extra == "all"
-Requires-Dist: torch<3,>=2.0.1; extra == "all"
+Requires-Dist: fastai<3,>=2.7.11; extra == "all"
+Requires-Dist: pyspark<=4,>=3.3.0; extra == "all"
 Provides-Extra: experimental
 Requires-Dist: xlearn==0.40a1; extra == "experimental"
 Requires-Dist: vowpalwabbit<9,>=8.9.0; extra == "experimental"

diff --git a/recommenders.egg-info/requires.txt b/recommenders.egg-info/requires.txt
@@ -23,17 +23,17 @@ pandera[strategies]<0.18,>=0.6.5
 pandera[strategies]>=0.15.0
 
 [all]
-pyspark<=4,>=3.3.0
-tf-slim>=1.1.0
-pyarrow>=10.0.1
-pytest-mock>=3.10.0
+torch<3,>=2.0.1
 nvidia-ml-py>=11.525.84
-tensorflow!=2.10.0.*,!=2.9.0.*,!=2.9.1,!=2.9.2,<2.16,>=2.8.4
-fastai<3,>=2.7.11
-pytest-cov>=4.1.0
 black>=23.3.0
+pytest-cov>=4.1.0
+tensorflow!=2.10.0.*,!=2.9.0.*,!=2.9.1,!=2.9.2,<2.16,>=2.8.4
+pytest-mock>=3.10.0
+pyarrow>=10.0.1
+tf-slim>=1.1.0
 pytest>=7.2.1
-torch<3,>=2.0.1
+fastai<3,>=2.7.11
+pyspark<=4,>=3.3.0
 
 [dev]
 black>=23.3.0