Deployed 1cda164cf1 to dev with MkDocs 1.6.0 and mike 2.1.1

online-ml · Aug 31, 2024 · e78dafb · e78dafb
1 parent d613f6c
commit e78dafb
Show file tree

Hide file tree

Showing 44 changed files with 44 additions and 41 deletions.
diff --git a/dev/api/anomaly/PredictiveAnomalyDetection/index.html b/dev/api/anomaly/PredictiveAnomalyDetection/index.html
@@ -3995,7 +3995,7 @@ <h2 id="examples">Examples<a class="headerlink" href="#examples" title="Permanen
 
 <span class="k">for</span> <span class="n">t</span><span class="p">,</span> <span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">)</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">datasets</span><span class="o">.</span><span class="n">AirlinePassengers</span><span class="p">()):</span>
     <span class="n">score</span> <span class="o">=</span> <span class="n">PAD</span><span class="o">.</span><span class="n">score_one</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">y</span><span class="p">)</span>
-    <span class="n">PAD</span> <span class="o">=</span> <span class="n">PAD</span><span class="o">.</span><span class="n">learn_one</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">y</span><span class="p">)</span>
+    <span class="n">PAD</span><span class="o">.</span><span class="n">learn_one</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">y</span><span class="p">)</span>
     <span class="n">scores</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">score</span><span class="p">)</span>
 
 <span class="nb">print</span><span class="p">(</span><span class="n">scores</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span>

diff --git a/dev/api/drift/binary/EDDM/index.html b/dev/api/drift/binary/EDDM/index.html
@@ -4137,7 +4137,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <li><strong>x</strong>     — <em>'bool'</em>    </li>
 </ul>
 <p><strong>Returns</strong></p>
-<p><em>BinaryDriftDetector</em>:     self</p>
+<p><em>None</em>:     self</p>
 </details>
 <p><span /></p>
 <div class="footnote">

diff --git a/dev/api/drift/binary/HDDM-A/index.html b/dev/api/drift/binary/HDDM-A/index.html
@@ -4123,7 +4123,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <li><strong>x</strong>     — <em>'bool'</em>    </li>
 </ul>
 <p><strong>Returns</strong></p>
-<p><em>BinaryDriftDetector</em>:     self</p>
+<p><em>None</em>:     self</p>
 </details>
 <p><span /></p>
 <div class="footnote">

diff --git a/dev/api/drift/binary/HDDM-W/index.html b/dev/api/drift/binary/HDDM-W/index.html
@@ -4128,7 +4128,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <li><strong>x</strong>     — <em>'bool'</em>    </li>
 </ul>
 <p><strong>Returns</strong></p>
-<p><em>BinaryDriftDetector</em>:     self</p>
+<p><em>None</em>:     self</p>
 </details>
 <p><span /></p>
 <div class="footnote">

diff --git a/dev/api/stats/AbsMax/index.html b/dev/api/stats/AbsMax/index.html
@@ -4453,7 +4453,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/AutoCorr/index.html b/dev/api/stats/AutoCorr/index.html
@@ -4494,7 +4494,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/BayesianMean/index.html b/dev/api/stats/BayesianMean/index.html
@@ -4448,7 +4448,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 </details>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/Count/index.html b/dev/api/stats/Count/index.html
@@ -4419,7 +4419,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>     — defaults to <code>None</code>    </li>

diff --git a/dev/api/stats/Cov/index.html b/dev/api/stats/Cov/index.html
@@ -4517,7 +4517,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 </details>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>    </li>

diff --git a/dev/api/stats/EWMean/index.html b/dev/api/stats/EWMean/index.html
@@ -4482,7 +4482,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/EWVar/index.html b/dev/api/stats/EWVar/index.html
@@ -4483,7 +4483,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/Entropy/index.html b/dev/api/stats/Entropy/index.html
@@ -4508,7 +4508,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/IQR/index.html b/dev/api/stats/IQR/index.html
@@ -4487,7 +4487,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/KolmogorovSmirnov/index.html b/dev/api/stats/KolmogorovSmirnov/index.html
@@ -4466,7 +4466,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 </details>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>    </li>

diff --git a/dev/api/stats/Kurtosis/index.html b/dev/api/stats/Kurtosis/index.html
@@ -4526,7 +4526,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/Link/index.html b/dev/api/stats/Link/index.html
@@ -4505,7 +4505,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/MAD/index.html b/dev/api/stats/MAD/index.html
@@ -4455,7 +4455,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/Max/index.html b/dev/api/stats/Max/index.html
@@ -4453,7 +4453,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/Mean/index.html b/dev/api/stats/Mean/index.html
@@ -4473,7 +4473,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 </details>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/Min/index.html b/dev/api/stats/Min/index.html
@@ -4419,7 +4419,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/Mode/index.html b/dev/api/stats/Mode/index.html
@@ -4489,7 +4489,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/NUnique/index.html b/dev/api/stats/NUnique/index.html
@@ -4506,7 +4506,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/PeakToPeak/index.html b/dev/api/stats/PeakToPeak/index.html
@@ -4450,7 +4450,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/PearsonCorr/index.html b/dev/api/stats/PearsonCorr/index.html
@@ -4514,7 +4514,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 </details>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>    </li>

diff --git a/dev/api/stats/Quantile/index.html b/dev/api/stats/Quantile/index.html
@@ -4492,7 +4492,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/RollingAbsMax/index.html b/dev/api/stats/RollingAbsMax/index.html
@@ -4481,7 +4481,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/RollingIQR/index.html b/dev/api/stats/RollingIQR/index.html
@@ -4500,7 +4500,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/RollingMax/index.html b/dev/api/stats/RollingMax/index.html
@@ -4481,7 +4481,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/RollingMin/index.html b/dev/api/stats/RollingMin/index.html
@@ -4481,7 +4481,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/RollingMode/index.html b/dev/api/stats/RollingMode/index.html
@@ -4494,7 +4494,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/RollingPeakToPeak/index.html b/dev/api/stats/RollingPeakToPeak/index.html
@@ -4483,7 +4483,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/RollingQuantile/index.html b/dev/api/stats/RollingQuantile/index.html
@@ -4495,7 +4495,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/SEM/index.html b/dev/api/stats/SEM/index.html
@@ -4499,7 +4499,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 </details>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/Shift/index.html b/dev/api/stats/Shift/index.html
@@ -4526,7 +4526,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/Skew/index.html b/dev/api/stats/Skew/index.html
@@ -4499,7 +4499,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/Sum/index.html b/dev/api/stats/Sum/index.html
@@ -4471,7 +4471,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 </details>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/Var/index.html b/dev/api/stats/Var/index.html
@@ -4517,7 +4517,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 </details>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/stats/base/Bivariate/index.html b/dev/api/stats/base/Bivariate/index.html
@@ -4443,7 +4443,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>    </li>

diff --git a/dev/api/stats/base/Univariate/index.html b/dev/api/stats/base/Univariate/index.html
@@ -4465,7 +4465,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <p><span /></p>
 <details class="- abstract">
 <summary>update</summary>
-<p>Update and return the called instance.</p>
+<p>Update the called instance.</p>
 <p><strong>Parameters</strong></p>
 <ul>
 <li><strong>x</strong>     — <em>'numbers.Number'</em>    </li>

diff --git a/dev/api/tree/iSOUPTreeRegressor/index.html b/dev/api/tree/iSOUPTreeRegressor/index.html
@@ -4181,6 +4181,7 @@ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent l
 <li><strong>x</strong>    </li>
 <li><strong>y</strong>    </li>
 <li><strong>w</strong>     — <em>'float'</em>     — defaults to <code>1.0</code>    </li>
+<li><strong>kwargs</strong>    </li>
 </ul>
 </details>
 <p><span /></p>

diff --git a/dev/api/utils/SortedWindow/index.html b/dev/api/utils/SortedWindow/index.html
@@ -4066,7 +4066,8 @@ <h2 id="examples">Examples<a class="headerlink" href="#examples" title="Permanen
 <span class="n">window</span> <span class="o">=</span> <span class="n">utils</span><span class="o">.</span><span class="n">SortedWindow</span><span class="p">(</span><span class="n">size</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span>
 
 <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">reversed</span><span class="p">(</span><span class="nb">range</span><span class="p">(</span><span class="mi">9</span><span class="p">)):</span>
-    <span class="nb">print</span><span class="p">(</span><span class="n">window</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">i</span><span class="p">))</span>
+    <span class="n">window</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">i</span><span class="p">)</span>
+    <span class="nb">print</span><span class="p">(</span><span class="n">window</span><span class="p">)</span>
 </code></pre></div>
 <div class="language-text highlight"><pre><span></span><code>[8]
 [7, 8]

diff --git a/dev/parse/__pycache__/__main__.cpython-312.pyc b/dev/parse/__pycache__/__main__.cpython-312.pyc
diff --git a/dev/releases/unreleased/index.html b/dev/releases/unreleased/index.html
@@ -1893,6 +1893,7 @@
 <h1 id="unreleased">Unreleased<a class="headerlink" href="#unreleased" title="Permanent link">&para;</a></h1>
 <ul>
 <li>The units used in River have been corrected to be based on powers of 2 (KiB, MiB). This only changes the display, the behaviour is unchanged.</li>
+<li>The methods <code>learn_one</code>, <code>learn_many</code>, <code>update</code>, <code>revert</code>, and <code>append</code> now return <code>None</code>.</li>
 </ul>
 <h2 id="cluster">cluster<a class="headerlink" href="#cluster" title="Permanent link">&para;</a></h2>
 <ul>

diff --git a/dev/search/search_index.json b/dev/search/search_index.json