Update docs

cumbof · Aug 16, 2024 · 3cec8cf · 3cec8cf
1 parent e3f6c07
commit 3cec8cf
Show file tree

Hide file tree

Showing 6 changed files with 199 additions and 67 deletions.
diff --git a/docs/arithmetic.html b/docs/arithmetic.html
@@ -248,7 +248,7 @@ <h2 id="examples">Examples</h2>
 </nav>
 </main>
 <footer id="footer">
-    <p>Copyright &copy; 2024 Fabio Cumbo - Distributed under the <a href="https://github.com/cumbof/hdlib/blob/main/LICENSE" target="_blank">MIT License</a> - Documentation generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
+<p>Copyright &copy; 2024 Fabio Cumbo - Distributed under the <a href="https://github.com/cumbof/hdlib/blob/main/LICENSE" target="_blank">MIT License</a> - Documentation generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
 </footer>
 </body>
 </html>
diff --git a/docs/graph.html b/docs/graph.html
@@ -593,7 +593,7 @@ <h2 id="examples">Examples</h2>
             self._weight_memory(0.0, 1.0, 0.01)
 
         graph = None
-        
+
         for node in self.space.space:
             # Check whether the current node is not the actual graph memory
             # Also, check whether the current node is not a weight vector
@@ -897,7 +897,7 @@ <h4><code><a title="hdlib.graph.Graph" href="#hdlib.graph.Graph">Graph</a></code
 </nav>
 </main>
 <footer id="footer">
-    <p>Copyright &copy; 2024 Fabio Cumbo - Distributed under the <a href="https://github.com/cumbof/hdlib/blob/main/LICENSE" target="_blank">MIT License</a> - Documentation generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
+<p>Copyright &copy; 2024 Fabio Cumbo - Distributed under the <a href="https://github.com/cumbof/hdlib/blob/main/LICENSE" target="_blank">MIT License</a> - Documentation generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
 </footer>
 </body>
 </html>
diff --git a/docs/index.html b/docs/index.html
@@ -22,7 +22,7 @@
 <main>
 <article id="content">
 <header>
-<h1 class="title">Package <code>hdlib</code> v0.1.17</h1>
+<h1 class="title">Package <code>hdlib</code> v0.1.18</h1>
 </header>
 <section id="section-intro">
 <p><strong>hdlib</strong> is a Python 3 library for building Vector-Symbolic Architectures (VSA, a.k.a. Hyperdimensional Computing).</p>

diff --git a/docs/model.html b/docs/model.html
@@ -184,7 +184,7 @@ <h2 id="examples">Examples</h2>
             Levels:  {}
             Points:  {}
             Classes:
-            
+
             {}
         &#34;&#34;&#34;.format(
             self.version,
@@ -446,7 +446,7 @@ <h2 id="examples">Examples</h2>
         distance_method: str=&#34;cosine&#34;
     ) -&gt; Tuple[float, List[Vector], List[str]]:
         &#34;&#34;&#34;Compute the error rate.
-        
+
         Parameters
         ----------
         training_vectors : list
@@ -1502,7 +1502,7 @@ <h4><code><a title="hdlib.model.MLModel" href="#hdlib.model.MLModel">MLModel</a>
 </nav>
 </main>
 <footer id="footer">
-    <p>Copyright &copy; 2024 Fabio Cumbo - Distributed under the <a href="https://github.com/cumbof/hdlib/blob/main/LICENSE" target="_blank">MIT License</a> - Documentation generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
+<p>Copyright &copy; 2024 Fabio Cumbo - Distributed under the <a href="https://github.com/cumbof/hdlib/blob/main/LICENSE" target="_blank">MIT License</a> - Documentation generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
 </footer>
 </body>
 </html>
diff --git a/docs/parser.html b/docs/parser.html
@@ -37,7 +37,7 @@ <h1 class="title">Module <code>hdlib.parser</code></h1>
 <h2 class="section-title" id="header-functions">Functions</h2>
 <dl>
 <dt id="hdlib.parser.load_dataset"><code class="name flex">
-<span>def <span class="ident">load_dataset</span></span>(<span>filepath: <function abspath at 0x7e4d8930a0>, sep: str = '\t') ‑> Tuple[List[str], List[List[float]], List[str]]</span>
+<span>def <span class="ident">load_dataset</span></span>(<span>filepath: <function abspath at 0x78622530a0>, sep: str = '\t') ‑> Tuple[List[str], List[List[float]], List[str]]</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Load the input numerical dataset.</p>
@@ -126,7 +126,7 @@ <h2 id="examples">Examples</h2>
 </nav>
 </main>
 <footer id="footer">
-    <p>Copyright &copy; 2024 Fabio Cumbo - Distributed under the <a href="https://github.com/cumbof/hdlib/blob/main/LICENSE" target="_blank">MIT License</a> - Documentation generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
+<p>Copyright &copy; 2024 Fabio Cumbo - Distributed under the <a href="https://github.com/cumbof/hdlib/blob/main/LICENSE" target="_blank">MIT License</a> - Documentation generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
 </footer>
 </body>
 </html>