Rebuilt the docs

mindsdb · Dec 25, 2023 · e356fba · e356fba
1 parent 3f91dba
commit e356fba
Show file tree

Hide file tree

Showing 17 changed files with 148 additions and 1,008 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: d6248c1d578c35129b4e130e17c17c68
+config: 3c3d6740e381830fc5186a45af4fc9dc
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_modules/base.html b/_modules/base.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>base &mdash; type_infer 0.0.17 documentation</title>
+  <title>base &mdash; type_infer 0.0.18 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css" />
       <link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
@@ -38,7 +38,7 @@
               <img src="../_static/mindsdblogo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                0.0.17
+                0.0.18
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@@ -106,6 +106,19 @@ <h1>Source code for base</h1><div class="highlight"><pre>
         <span class="bp">self</span><span class="o">.</span><span class="n">dtypes</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">additional_info</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">identifiers</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span></div>
+
+
+<span class="k">class</span> <span class="nc">BaseEngine</span><span class="p">:</span>
+    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">stable</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">stable</span> <span class="o">=</span> <span class="n">stable</span>  <span class="c1"># whether the engine is stable or not (i.e. experimental)</span>
+
+    <span class="k">def</span> <span class="nf">infer</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">df</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">TypeInformation</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Given a dataframe, infer the types of each column and return a TypeInformation object.&quot;&quot;&quot;</span>
+        <span class="k">raise</span> <span class="ne">NotImplementedError</span>
+
+
+<span class="k">class</span> <span class="nc">ENGINES</span><span class="p">:</span>
+    <span class="n">RULE_BASED</span> <span class="o">=</span> <span class="s1">&#39;rule_based&#39;</span>
 </pre></div>
 
            </div>

diff --git a/_modules/dtype.html b/_modules/dtype.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>dtype &mdash; type_infer 0.0.17 documentation</title>
+  <title>dtype &mdash; type_infer 0.0.18 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css" />
       <link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
@@ -38,7 +38,7 @@
               <img src="../_static/mindsdblogo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                0.0.17
+                0.0.18
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@@ -127,6 +127,9 @@ <h1>Source code for dtype</h1><div class="highlight"><pre>
     <span class="c1"># Misc (Unk/NaNs)</span>
     <span class="n">empty</span> <span class="o">=</span> <span class="s2">&quot;empty&quot;</span>
     <span class="n">invalid</span> <span class="o">=</span> <span class="s2">&quot;invalid&quot;</span></div>
+
+
+<span class="c1"># TODO: modifier class + system</span>
 </pre></div>
 
            </div>

diff --git a/_modules/helpers.html b/_modules/helpers.html
diff --git a/_modules/index.html b/_modules/index.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Overview: module code &mdash; type_infer 0.0.17 documentation</title>
+  <title>Overview: module code &mdash; type_infer 0.0.18 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css" />
       <link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
@@ -38,7 +38,7 @@
               <img src="../_static/mindsdblogo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                0.0.17
+                0.0.18
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@@ -82,7 +82,6 @@ <h1>All modules for which code is available</h1>
 <ul><li><a href="base.html">base</a></li>
 <li><a href="dtype.html">dtype</a></li>
 <li><a href="helpers.html">helpers</a></li>
-<li><a href="infer.html">infer</a></li>
 </ul>
 
            </div>