Auto-update documentation

romanwerpachowski · Sep 12, 2021 · bbd0d38 · bbd0d38
1 parent 8607ec7
commit bbd0d38
Show file tree

Hide file tree

Showing 21 changed files with 158 additions and 19 deletions.
diff --git a/docs/cppyml/doctrees/environment.pickle b/docs/cppyml/doctrees/environment.pickle
diff --git a/docs/cppyml/doctrees/index.doctree b/docs/cppyml/doctrees/index.doctree
diff --git a/docs/cppyml/html/genindex.html b/docs/cppyml/html/genindex.html
@@ -69,6 +69,8 @@ <h2 id="A">A</h2>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#cppyml.cppyml.clustering.KMeans.assign_label">assign_label() (cppyml.cppyml.clustering.KMeans method)</a>
+</li>
       <li><a href="index.html#cppyml.cppyml.clustering.EM.assign_responsibilities">assign_responsibilities() (cppyml.cppyml.clustering.EM method)</a>
 </li>
   </ul></td>
@@ -93,6 +95,8 @@ <h2 id="B">B</h2>
 <h2 id="C">C</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#cppyml.cppyml.clustering.KMeans.centroids">centroids (cppyml.cppyml.clustering.KMeans attribute)</a>
+</li>
       <li><a href="index.html#cppyml.cppyml.clustering.CentroidsInitialiser">CentroidsInitialiser (class in cppyml.cppyml.clustering)</a>
 </li>
       <li><a href="index.html#cppyml.cppyml.decision_trees.classification_tree">classification_tree() (in module cppyml.cppyml.decision_trees)</a>
@@ -164,7 +168,11 @@ <h2 id="F">F</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#cppyml.cppyml.clustering.EM.fit">fit() (cppyml.cppyml.clustering.EM method)</a>
+
+      <ul>
+        <li><a href="index.html#cppyml.cppyml.clustering.KMeans.fit">(cppyml.cppyml.clustering.KMeans method)</a>
 </li>
+      </ul></li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#cppyml.cppyml.clustering.Forgy">Forgy (class in cppyml.cppyml.clustering)</a>
@@ -174,6 +182,10 @@ <h2 id="F">F</h2>
 
 <h2 id="I">I</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#cppyml.cppyml.clustering.KMeans.inertia">inertia (cppyml.cppyml.clustering.KMeans attribute)</a>
+</li>
+  </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#cppyml.cppyml.linear_regression.UnivariateOLSResult.intercept">intercept (cppyml.cppyml.linear_regression.UnivariateOLSResult attribute)</a>
 </li>
@@ -182,6 +194,10 @@ <h2 id="I">I</h2>
 
 <h2 id="K">K</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#cppyml.cppyml.clustering.KMeans">KMeans (class in cppyml.cppyml.clustering)</a>
+</li>
+  </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#cppyml.cppyml.clustering.KPP">KPP (class in cppyml.cppyml.clustering)</a>
 </li>
@@ -191,6 +207,8 @@ <h2 id="K">K</h2>
 <h2 id="L">L</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#cppyml.cppyml.clustering.KMeans.labels">labels (cppyml.cppyml.clustering.KMeans attribute)</a>
+</li>
       <li><a href="index.html#cppyml.cppyml.linear_regression.lasso">lasso() (in module cppyml.cppyml.linear_regression)</a>
 </li>
   </ul></td>
@@ -227,6 +245,8 @@ <h2 id="N">N</h2>
         <li><a href="index.html#cppyml.cppyml.linear_regression.Result.n">(cppyml.cppyml.linear_regression.Result attribute)</a>
 </li>
       </ul></li>
+      <li><a href="index.html#cppyml.cppyml.clustering.KMeans.number_clusters">number_clusters (cppyml.cppyml.clustering.KMeans attribute)</a>
+</li>
       <li><a href="index.html#cppyml.cppyml.clustering.EM.number_components">number_components (cppyml.cppyml.clustering.EM attribute)</a>
 </li>
       <li><a href="index.html#cppyml.cppyml.decision_trees.ClassificationTree.number_leaf_nodes">number_leaf_nodes (cppyml.cppyml.decision_trees.ClassificationTree attribute)</a>
@@ -312,23 +332,43 @@ <h2 id="S">S</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#cppyml.cppyml.clustering.EM.set_absolute_tolerance">set_absolute_tolerance() (cppyml.cppyml.clustering.EM method)</a>
+
+      <ul>
+        <li><a href="index.html#cppyml.cppyml.clustering.KMeans.set_absolute_tolerance">(cppyml.cppyml.clustering.KMeans method)</a>
+</li>
+      </ul></li>
+      <li><a href="index.html#cppyml.cppyml.clustering.KMeans.set_centroids_initialiser">set_centroids_initialiser() (cppyml.cppyml.clustering.KMeans method)</a>
 </li>
       <li><a href="index.html#cppyml.cppyml.clustering.EM.set_maximise_first">set_maximise_first() (cppyml.cppyml.clustering.EM method)</a>
 </li>
       <li><a href="index.html#cppyml.cppyml.clustering.EM.set_maximum_steps">set_maximum_steps() (cppyml.cppyml.clustering.EM method)</a>
+
+      <ul>
+        <li><a href="index.html#cppyml.cppyml.clustering.KMeans.set_maximum_steps">(cppyml.cppyml.clustering.KMeans method)</a>
 </li>
+      </ul></li>
       <li><a href="index.html#cppyml.cppyml.clustering.EM.set_means_initialiser">set_means_initialiser() (cppyml.cppyml.clustering.EM method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#cppyml.cppyml.clustering.KMeans.set_number_initialisations">set_number_initialisations() (cppyml.cppyml.clustering.KMeans method)</a>
+</li>
       <li><a href="index.html#cppyml.cppyml.clustering.EM.set_relative_tolerance">set_relative_tolerance() (cppyml.cppyml.clustering.EM method)</a>
 </li>
       <li><a href="index.html#cppyml.cppyml.clustering.EM.set_responsibilities_initialiser">set_responsibilities_initialiser() (cppyml.cppyml.clustering.EM method)</a>
 </li>
       <li><a href="index.html#cppyml.cppyml.clustering.EM.set_seed">set_seed() (cppyml.cppyml.clustering.EM method)</a>
+
+      <ul>
+        <li><a href="index.html#cppyml.cppyml.clustering.KMeans.set_seed">(cppyml.cppyml.clustering.KMeans method)</a>
 </li>
+      </ul></li>
       <li><a href="index.html#cppyml.cppyml.clustering.EM.set_verbose">set_verbose() (cppyml.cppyml.clustering.EM method)</a>
+
+      <ul>
+        <li><a href="index.html#cppyml.cppyml.clustering.KMeans.set_verbose">(cppyml.cppyml.clustering.KMeans method)</a>
 </li>
+      </ul></li>
       <li><a href="index.html#cppyml.cppyml.linear_regression.UnivariateOLSResult.slope">slope (cppyml.cppyml.linear_regression.UnivariateOLSResult attribute)</a>
 </li>
   </ul></td>

diff --git a/docs/cppyml/html/index.html b/docs/cppyml/html/index.html
@@ -209,6 +209,105 @@ <h3>Navigation</h3>
 <p>Forgy initialisation algorithm.</p>
 </dd></dl>
 
+<dl class="class">
+<dt id="cppyml.cppyml.clustering.KMeans">
+<em class="property">class </em><code class="descclassname">cppyml.cppyml.clustering.</code><code class="descname">KMeans</code><a class="headerlink" href="#cppyml.cppyml.clustering.KMeans" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">pybind11_builtins.pybind11_object</span></code></p>
+<p>Naive K-Means algorithm.</p>
+<dl class="method">
+<dt id="cppyml.cppyml.clustering.KMeans.assign_label">
+<code class="descname">assign_label</code><span class="sig-paren">(</span><em>self: cppyml.cppyml.clustering.KMeans, x: numpy.ndarray[float64[m, 1]]</em><span class="sig-paren">)</span> &#x2192; Tuple[int, float]<a class="headerlink" href="#cppyml.cppyml.clustering.KMeans.assign_label" title="Permalink to this definition">¶</a></dt>
+<dd><p>Given a data point x, assigns it to the closest cluster.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> – Data point with correct dimension.</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Cluster label for point x.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="cppyml.cppyml.clustering.KMeans.centroids">
+<code class="descname">centroids</code><a class="headerlink" href="#cppyml.cppyml.clustering.KMeans.centroids" title="Permalink to this definition">¶</a></dt>
+<dd><p>Fitted centroids.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="cppyml.cppyml.clustering.KMeans.fit">
+<code class="descname">fit</code><span class="sig-paren">(</span><em>self: cppyml.cppyml.clustering.KMeans, data: numpy.ndarray[float64[m, n], flags.c_contiguous]</em><span class="sig-paren">)</span> &#x2192; bool<a class="headerlink" href="#cppyml.cppyml.clustering.KMeans.fit" title="Permalink to this definition">¶</a></dt>
+<dd><p>Fits the components to the data.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> – A 2D array with data points in rows.</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if EM algorithm converged.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="cppyml.cppyml.clustering.KMeans.inertia">
+<code class="descname">inertia</code><a class="headerlink" href="#cppyml.cppyml.clustering.KMeans.inertia" title="Permalink to this definition">¶</a></dt>
+<dd><p>Minimised inertia.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="cppyml.cppyml.clustering.KMeans.labels">
+<code class="descname">labels</code><a class="headerlink" href="#cppyml.cppyml.clustering.KMeans.labels" title="Permalink to this definition">¶</a></dt>
+<dd><p>Fitted labels.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="cppyml.cppyml.clustering.KMeans.number_clusters">
+<code class="descname">number_clusters</code><a class="headerlink" href="#cppyml.cppyml.clustering.KMeans.number_clusters" title="Permalink to this definition">¶</a></dt>
+<dd><p>Number of clusters.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="cppyml.cppyml.clustering.KMeans.set_absolute_tolerance">
+<code class="descname">set_absolute_tolerance</code><span class="sig-paren">(</span><em>self: cppyml.cppyml.clustering.KMeans</em>, <em>absolute_tolerance: float</em><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#cppyml.cppyml.clustering.KMeans.set_absolute_tolerance" title="Permalink to this definition">¶</a></dt>
+<dd><p>Sets absolute tolerance.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="cppyml.cppyml.clustering.KMeans.set_centroids_initialiser">
+<code class="descname">set_centroids_initialiser</code><span class="sig-paren">(</span><em>self: cppyml.cppyml.clustering.KMeans</em>, <em>centroids_initialiser: cppyml.cppyml.clustering.CentroidsInitialiser</em><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#cppyml.cppyml.clustering.KMeans.set_centroids_initialiser" title="Permalink to this definition">¶</a></dt>
+<dd><p>Sets the algorithm to initialise cluster centroids.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="cppyml.cppyml.clustering.KMeans.set_maximum_steps">
+<code class="descname">set_maximum_steps</code><span class="sig-paren">(</span><em>self: cppyml.cppyml.clustering.KMeans</em>, <em>maximum_steps: int</em><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#cppyml.cppyml.clustering.KMeans.set_maximum_steps" title="Permalink to this definition">¶</a></dt>
+<dd><p>Sets maximum number of iterations.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="cppyml.cppyml.clustering.KMeans.set_number_initialisations">
+<code class="descname">set_number_initialisations</code><span class="sig-paren">(</span><em>self: cppyml.cppyml.clustering.KMeans</em>, <em>centroids_initialiser: int</em><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#cppyml.cppyml.clustering.KMeans.set_number_initialisations" title="Permalink to this definition">¶</a></dt>
+<dd><p>Sets number of initialisations to try, to find the clusters with lowest inertia.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="cppyml.cppyml.clustering.KMeans.set_seed">
+<code class="descname">set_seed</code><span class="sig-paren">(</span><em>self: cppyml.cppyml.clustering.KMeans</em>, <em>seed: int</em><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#cppyml.cppyml.clustering.KMeans.set_seed" title="Permalink to this definition">¶</a></dt>
+<dd><p>Sets the PRNG seed.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="cppyml.cppyml.clustering.KMeans.set_verbose">
+<code class="descname">set_verbose</code><span class="sig-paren">(</span><em>self: cppyml.cppyml.clustering.KMeans</em>, <em>verbose: bool</em><span class="sig-paren">)</span> &#x2192; None<a class="headerlink" href="#cppyml.cppyml.clustering.KMeans.set_verbose" title="Permalink to this definition">¶</a></dt>
+<dd><p>Turns on/off the verbose mode.</p>
+</dd></dl>
+
+</dd></dl>
+
 <dl class="class">
 <dt id="cppyml.cppyml.clustering.KPP">
 <em class="property">class </em><code class="descclassname">cppyml.cppyml.clustering.</code><code class="descname">KPP</code><a class="headerlink" href="#cppyml.cppyml.clustering.KPP" title="Permalink to this definition">¶</a></dt>

diff --git a/docs/cppyml/html/objects.inv b/docs/cppyml/html/objects.inv