deploy: 16d9f6d

_sources/generated/streamsight.algorithms.Popularity.rst.txt

@@ -0,0 +1,40 @@
+streamsight.algorithms.Popularity
+=================================
+
+.. currentmodule:: streamsight.algorithms
+
+.. autoclass:: Popularity
+   :members:                             
+   :show-inheritance:   
+   :private-members:   
+   :undoc-members:        
+   :inherited-members:               
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Popularity.__init__
+      ~Popularity.fit
+      ~Popularity.get_metadata_routing
+      ~Popularity.get_params
+      ~Popularity.predict
+      ~Popularity.set_params
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~Popularity.identifier
+      ~Popularity.name
+      ~Popularity.ITEM_USER_BASED
+
+

_sources/generated/streamsight.algorithms.Random.rst.txt

@@ -0,0 +1,40 @@
+streamsight.algorithms.Random
+=============================
+
+.. currentmodule:: streamsight.algorithms
+
+.. autoclass:: Random
+   :members:                             
+   :show-inheritance:   
+   :private-members:   
+   :undoc-members:        
+   :inherited-members:               
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Random.__init__
+      ~Random.fit
+      ~Random.get_metadata_routing
+      ~Random.get_params
+      ~Random.predict
+      ~Random.set_params
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~Random.identifier
+      ~Random.name
+      ~Random.ITEM_USER_BASED
+
+

_sources/generated/streamsight.metrics.Metric.rst.txt

@@ -0,0 +1,44 @@
+streamsight.metrics.Metric
+==========================
+
+.. currentmodule:: streamsight.metrics
+
+.. autoclass:: Metric
+   :members:                             
+   :show-inheritance:   
+   :private-members:   
+   :undoc-members:        
+   :inherited-members:               
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Metric.__init__
+      ~Metric.cache_values
+      ~Metric.calculate
+      ~Metric.calculate_cached
+      ~Metric.get_params
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~Metric.identifier
+      ~Metric.macro_result
+      ~Metric.micro_result
+      ~Metric.name
+      ~Metric.num_items
+      ~Metric.num_users
+      ~Metric.params
+      ~Metric.timestamp_limit
+
+

_sources/generated/streamsight.metrics.PrecisionK.rst.txt

@@ -0,0 +1,46 @@
+streamsight.metrics.PrecisionK
+==============================
+
+.. currentmodule:: streamsight.metrics
+
+.. autoclass:: PrecisionK
+   :members:                             
+   :show-inheritance:   
+   :private-members:   
+   :undoc-members:        
+   :inherited-members:               
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~PrecisionK.__init__
+      ~PrecisionK.cache_values
+      ~PrecisionK.calculate
+      ~PrecisionK.calculate_cached
+      ~PrecisionK.get_params
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~PrecisionK.DEFAULT_K
+      ~PrecisionK.col_names
+      ~PrecisionK.identifier
+      ~PrecisionK.macro_result
+      ~PrecisionK.micro_result
+      ~PrecisionK.name
+      ~PrecisionK.num_items
+      ~PrecisionK.num_users
+      ~PrecisionK.params
+      ~PrecisionK.timestamp_limit
+
+

_sources/generated/streamsight.metrics.RecallK.rst.txt

@@ -0,0 +1,46 @@
+streamsight.metrics.RecallK
+===========================
+
+.. currentmodule:: streamsight.metrics
+
+.. autoclass:: RecallK
+   :members:                             
+   :show-inheritance:   
+   :private-members:   
+   :undoc-members:        
+   :inherited-members:               
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~RecallK.__init__
+      ~RecallK.cache_values
+      ~RecallK.calculate
+      ~RecallK.calculate_cached
+      ~RecallK.get_params
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~RecallK.DEFAULT_K
+      ~RecallK.col_names
+      ~RecallK.identifier
+      ~RecallK.macro_result
+      ~RecallK.micro_result
+      ~RecallK.name
+      ~RecallK.num_items
+      ~RecallK.num_users
+      ~RecallK.params
+      ~RecallK.timestamp_limit
+
+

generated/streamsight.algorithms.Algorithm.html

@@ -21,7 +21,7 @@
     <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="streamsight.algorithms.ItemKNN" href="streamsight.algorithms.ItemKNN.html" />
+    <link rel="next" title="streamsight.algorithms.Random" href="streamsight.algorithms.Random.html" />
     <link rel="prev" title="streamsight.algorithms" href="../streamsight.algorithms.html" /> 
 </head>
 
@@ -61,6 +61,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="../streamsight.algorithms.html#baseline-algorithms">Baseline Algorithms</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../streamsight.algorithms.html#item-similarity-algorithms">Item Similarity Algorithms</a></li>
 </ul>
 </li>
@@ -406,7 +407,7 @@ <h2>Returns<a class="headerlink" href="#id4" title="Link to this heading"></a
 <p>Data will be turned into a binary csr matrix.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>X</strong> (<em>Matrix</em>) – User-item interaction matrix to fit the model to</p>
+<dd class="field-odd"><p><strong>X</strong> (<a class="reference internal" href="streamsight.matrix.InteractionMatrix.html#streamsight.matrix.InteractionMatrix" title="streamsight.matrix.InteractionMatrix"><em>InteractionMatrix</em></a>) – User-item interaction matrix to fit the model to</p>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><p>Transformed user-item interaction matrix to fit the model</p>
@@ -424,7 +425,7 @@ <h2>Returns<a class="headerlink" href="#id4" title="Link to this heading"></a
 <p>Data will be turned into a binary csr matrix.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>X</strong> (<em>Matrix</em>) – User-item interaction matrix used as input to predict</p>
+<dd class="field-odd"><p><strong>X</strong> (<a class="reference internal" href="streamsight.matrix.InteractionMatrix.html#streamsight.matrix.InteractionMatrix" title="streamsight.matrix.InteractionMatrix"><em>InteractionMatrix</em></a>) – User-item interaction matrix used as input to predict</p>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><p>Transformed user-item interaction matrix used as input to predict</p>
@@ -520,10 +521,10 @@ <h2>Returns<a class="headerlink" href="#id8" title="Link to this heading"></a
 was successful using <a class="reference internal" href="#streamsight.algorithms.Algorithm._check_fit_complete" title="streamsight.algorithms.Algorithm._check_fit_complete"><code class="xref py py-meth docutils literal notranslate"><span class="pre">_check_fit_complete()</span></code></a>.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>X</strong> (<em>Matrix</em>) – The interactions to fit the model on.</p>
+<dd class="field-odd"><p><strong>X</strong> (<a class="reference internal" href="streamsight.matrix.InteractionMatrix.html#streamsight.matrix.InteractionMatrix" title="streamsight.matrix.InteractionMatrix"><em>InteractionMatrix</em></a>) – The interactions to fit the model on.</p>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p><strong>self</strong>, fitted algorithm</p>
+<dd class="field-even"><p>Fitted algorithm</p>
 </dd>
 <dt class="field-odd">Return type<span class="colon">:</span></dt>
 <dd class="field-odd"><p><a class="reference internal" href="#streamsight.algorithms.Algorithm" title="streamsight.algorithms.Algorithm">Algorithm</a></p>
@@ -626,7 +627,7 @@ <h2>Returns<a class="headerlink" href="#id11" title="Link to this heading"></
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="../streamsight.algorithms.html" class="btn btn-neutral float-left" title="streamsight.algorithms" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="streamsight.algorithms.ItemKNN.html" class="btn btn-neutral float-right" title="streamsight.algorithms.ItemKNN" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="streamsight.algorithms.Random.html" class="btn btn-neutral float-right" title="streamsight.algorithms.Random" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>

generated/streamsight.algorithms.ItemKNN.html

@@ -23,7 +23,7 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="streamsight.algorithms.ItemKNNIncremental" href="streamsight.algorithms.ItemKNNIncremental.html" />
-    <link rel="prev" title="streamsight.algorithms.Algorithm" href="streamsight.algorithms.Algorithm.html" /> 
+    <link rel="prev" title="streamsight.algorithms.Popularity" href="streamsight.algorithms.Popularity.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -56,6 +56,7 @@
 <ul class="current">
 <li class="toctree-l1 current"><a class="reference internal" href="../streamsight.algorithms.html">streamsight.algorithms</a><ul class="current">
 <li class="toctree-l2"><a class="reference internal" href="../streamsight.algorithms.html#algorithm">Algorithm</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../streamsight.algorithms.html#baseline-algorithms">Baseline Algorithms</a></li>
 <li class="toctree-l2 current"><a class="reference internal" href="../streamsight.algorithms.html#item-similarity-algorithms">Item Similarity Algorithms</a><ul class="current">
 <li class="toctree-l3 current"><a class="current reference internal" href="#">streamsight.algorithms.ItemKNN</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="#streamsight.algorithms.ItemKNN"><code class="docutils literal notranslate"><span class="pre">ItemKNN</span></code></a></li>
@@ -412,7 +413,7 @@ <h2>Returns<a class="headerlink" href="#id6" title="Link to this heading"></a
 <p>Data will be turned into a binary csr matrix.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>X</strong> (<em>Matrix</em>) – User-item interaction matrix to fit the model to</p>
+<dd class="field-odd"><p><strong>X</strong> (<a class="reference internal" href="streamsight.matrix.InteractionMatrix.html#streamsight.matrix.InteractionMatrix" title="streamsight.matrix.InteractionMatrix"><em>InteractionMatrix</em></a>) – User-item interaction matrix to fit the model to</p>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><p>Transformed user-item interaction matrix to fit the model</p>
@@ -430,7 +431,7 @@ <h2>Returns<a class="headerlink" href="#id6" title="Link to this heading"></a
 <p>Data will be turned into a binary csr matrix.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>X</strong> (<em>Matrix</em>) – User-item interaction matrix used as input to predict</p>
+<dd class="field-odd"><p><strong>X</strong> (<a class="reference internal" href="streamsight.matrix.InteractionMatrix.html#streamsight.matrix.InteractionMatrix" title="streamsight.matrix.InteractionMatrix"><em>InteractionMatrix</em></a>) – User-item interaction matrix used as input to predict</p>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><p>Transformed user-item interaction matrix used as input to predict</p>
@@ -526,10 +527,10 @@ <h2>Returns<a class="headerlink" href="#id10" title="Link to this heading"></
 was successful using <a class="reference internal" href="#streamsight.algorithms.ItemKNN._check_fit_complete" title="streamsight.algorithms.ItemKNN._check_fit_complete"><code class="xref py py-meth docutils literal notranslate"><span class="pre">_check_fit_complete()</span></code></a>.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>X</strong> (<em>Matrix</em>) – The interactions to fit the model on.</p>
+<dd class="field-odd"><p><strong>X</strong> (<a class="reference internal" href="streamsight.matrix.InteractionMatrix.html#streamsight.matrix.InteractionMatrix" title="streamsight.matrix.InteractionMatrix"><em>InteractionMatrix</em></a>) – The interactions to fit the model on.</p>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p><strong>self</strong>, fitted algorithm</p>
+<dd class="field-even"><p>Fitted algorithm</p>
 </dd>
 <dt class="field-odd">Return type<span class="colon">:</span></dt>
 <dd class="field-odd"><p><a class="reference internal" href="streamsight.algorithms.Algorithm.html#streamsight.algorithms.Algorithm" title="streamsight.algorithms.Algorithm">Algorithm</a></p>
@@ -631,7 +632,7 @@ <h2>Returns<a class="headerlink" href="#id13" title="Link to this heading"></
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="streamsight.algorithms.Algorithm.html" class="btn btn-neutral float-left" title="streamsight.algorithms.Algorithm" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="streamsight.algorithms.Popularity.html" class="btn btn-neutral float-left" title="streamsight.algorithms.Popularity" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="streamsight.algorithms.ItemKNNIncremental.html" class="btn btn-neutral float-right" title="streamsight.algorithms.ItemKNNIncremental" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 

generated/streamsight.algorithms.ItemKNNIncremental.html

@@ -55,6 +55,7 @@
 <ul class="current">
 <li class="toctree-l1 current"><a class="reference internal" href="../streamsight.algorithms.html">streamsight.algorithms</a><ul class="current">
 <li class="toctree-l2"><a class="reference internal" href="../streamsight.algorithms.html#algorithm">Algorithm</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../streamsight.algorithms.html#baseline-algorithms">Baseline Algorithms</a></li>
 <li class="toctree-l2 current"><a class="reference internal" href="../streamsight.algorithms.html#item-similarity-algorithms">Item Similarity Algorithms</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="streamsight.algorithms.ItemKNN.html">streamsight.algorithms.ItemKNN</a></li>
 <li class="toctree-l3 current"><a class="current reference internal" href="#">streamsight.algorithms.ItemKNNIncremental</a><ul>
@@ -400,7 +401,7 @@ <h2>Returns<a class="headerlink" href="#id4" title="Link to this heading"></a
 <p>Data will be turned into a binary csr matrix.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>X</strong> (<em>Matrix</em>) – User-item interaction matrix to fit the model to</p>
+<dd class="field-odd"><p><strong>X</strong> (<a class="reference internal" href="streamsight.matrix.InteractionMatrix.html#streamsight.matrix.InteractionMatrix" title="streamsight.matrix.InteractionMatrix"><em>InteractionMatrix</em></a>) – User-item interaction matrix to fit the model to</p>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><p>Transformed user-item interaction matrix to fit the model</p>
@@ -418,7 +419,7 @@ <h2>Returns<a class="headerlink" href="#id4" title="Link to this heading"></a
 <p>Data will be turned into a binary csr matrix.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>X</strong> (<em>Matrix</em>) – User-item interaction matrix used as input to predict</p>
+<dd class="field-odd"><p><strong>X</strong> (<a class="reference internal" href="streamsight.matrix.InteractionMatrix.html#streamsight.matrix.InteractionMatrix" title="streamsight.matrix.InteractionMatrix"><em>InteractionMatrix</em></a>) – User-item interaction matrix used as input to predict</p>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><p>Transformed user-item interaction matrix used as input to predict</p>
@@ -514,10 +515,10 @@ <h2>Returns<a class="headerlink" href="#id8" title="Link to this heading"></a
 was successful using <a class="reference internal" href="#streamsight.algorithms.ItemKNNIncremental._check_fit_complete" title="streamsight.algorithms.ItemKNNIncremental._check_fit_complete"><code class="xref py py-meth docutils literal notranslate"><span class="pre">_check_fit_complete()</span></code></a>.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>X</strong> (<em>Matrix</em>) – The interactions to fit the model on.</p>
+<dd class="field-odd"><p><strong>X</strong> (<a class="reference internal" href="streamsight.matrix.InteractionMatrix.html#streamsight.matrix.InteractionMatrix" title="streamsight.matrix.InteractionMatrix"><em>InteractionMatrix</em></a>) – The interactions to fit the model on.</p>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p><strong>self</strong>, fitted algorithm</p>
+<dd class="field-even"><p>Fitted algorithm</p>
 </dd>
 <dt class="field-odd">Return type<span class="colon">:</span></dt>
 <dd class="field-odd"><p><a class="reference internal" href="streamsight.algorithms.Algorithm.html#streamsight.algorithms.Algorithm" title="streamsight.algorithms.Algorithm">Algorithm</a></p>