update

codeai-ice-team · Feb 6, 2024 · 773edcc · 773edcc
1 parent e90df6f
commit 773edcc
Show file tree

Hide file tree

Showing 18 changed files with 748 additions and 201 deletions.
diff --git a/docs/_sources/reference/ice.base.rst.txt b/docs/_sources/reference/ice.base.rst.txt
@@ -0,0 +1,10 @@
+Base modules
+============
+
+
+.. automodule:: ice.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+   .. automethod:: __init__
diff --git a/docs/_sources/reference/index.rst.txt b/docs/_sources/reference/index.rst.txt
@@ -6,21 +6,10 @@ API reference
 
 .. toctree::
    :maxdepth: 2
-   :hidden:
 
+   Base modules <ice.base>
    Fault Diagnosis<ice.fault_diagnosis>
    Anomaly detection <ice.anomaly_detection>
    Remaining useful lifetime <ice.remaining_useful_life_estimation>
    Health index <ice.health_index_estimation>
    Configs <ice.configs>
-
-
-Base modules
-------------
-
-.. automodule:: ice.base
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-   .. automethod:: __init__
diff --git a/docs/genindex.html b/docs/genindex.html
@@ -369,9 +369,9 @@ <h2 id="_">_</h2>
 </li>
         <li><a href="reference/ice.anomaly_detection.html#ice.anomaly_detection.utils.SlidingWindowDataset.__init__">(ice.anomaly_detection.utils.SlidingWindowDataset method)</a>
 </li>
-        <li><a href="reference/ice.html#ice.base.BaseDataset.__init__">(ice.base.BaseDataset method)</a>, <a href="reference/index.html#ice.base.BaseDataset.__init__">[1]</a>
+        <li><a href="reference/ice.base.html#ice.base.BaseDataset.__init__">(ice.base.BaseDataset method)</a>, <a href="reference/ice.html#ice.base.BaseDataset.__init__">[1]</a>
 </li>
-        <li><a href="reference/ice.html#ice.base.BaseModel.__init__">(ice.base.BaseModel method)</a>, <a href="reference/index.html#ice.base.BaseModel.__init__">[1]</a>
+        <li><a href="reference/ice.base.html#ice.base.BaseModel.__init__">(ice.base.BaseModel method)</a>, <a href="reference/ice.html#ice.base.BaseModel.__init__">[1]</a>
 </li>
         <li><a href="reference/ice.configs.html#ice.configs.Config.__init__">(ice.configs.Config method)</a>
 </li>
@@ -424,15 +424,15 @@ <h2 id="B">B</h2>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="reference/ice.anomaly_detection.models.html#ice.anomaly_detection.models.base.BaseAnomalyDetection">BaseAnomalyDetection (class in ice.anomaly_detection.models.base)</a>
 </li>
-      <li><a href="reference/ice.html#ice.base.BaseDataset">BaseDataset (class in ice.base)</a>, <a href="reference/index.html#ice.base.BaseDataset">[1]</a>
+      <li><a href="reference/ice.base.html#ice.base.BaseDataset">BaseDataset (class in ice.base)</a>, <a href="reference/ice.html#ice.base.BaseDataset">[1]</a>
 </li>
       <li><a href="reference/ice.fault_diagnosis.models.html#ice.fault_diagnosis.models.base.BaseFaultDiagnosis">BaseFaultDiagnosis (class in ice.fault_diagnosis.models.base)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="reference/ice.health_index_estimation.models.html#ice.health_index_estimation.models.base.BaseHealthIndexEstimation">BaseHealthIndexEstimation (class in ice.health_index_estimation.models.base)</a>
 </li>
-      <li><a href="reference/ice.html#ice.base.BaseModel">BaseModel (class in ice.base)</a>, <a href="reference/index.html#ice.base.BaseModel">[1]</a>
+      <li><a href="reference/ice.base.html#ice.base.BaseModel">BaseModel (class in ice.base)</a>, <a href="reference/ice.html#ice.base.BaseModel">[1]</a>
 </li>
       <li><a href="reference/ice.remaining_useful_life_estimation.models.html#ice.remaining_useful_life_estimation.models.base.BaseRemainingUsefulLifeEstimation">BaseRemainingUsefulLifeEstimation (class in ice.remaining_useful_life_estimation.models.base)</a>
 </li>
@@ -457,7 +457,7 @@ <h2 id="E">E</h2>
       <li><a href="reference/ice.anomaly_detection.models.html#ice.anomaly_detection.models.base.BaseAnomalyDetection.evaluate">evaluate() (ice.anomaly_detection.models.base.BaseAnomalyDetection method)</a>
 
       <ul>
-        <li><a href="reference/ice.html#ice.base.BaseModel.evaluate">(ice.base.BaseModel method)</a>, <a href="reference/index.html#ice.base.BaseModel.evaluate">[1]</a>
+        <li><a href="reference/ice.base.html#ice.base.BaseModel.evaluate">(ice.base.BaseModel method)</a>, <a href="reference/ice.html#ice.base.BaseModel.evaluate">[1]</a>
 </li>
         <li><a href="reference/ice.fault_diagnosis.models.html#ice.fault_diagnosis.models.base.BaseFaultDiagnosis.evaluate">(ice.fault_diagnosis.models.base.BaseFaultDiagnosis method)</a>
 </li>
@@ -483,10 +483,10 @@ <h2 id="F">F</h2>
       <li><a href="reference/ice.anomaly_detection.models.html#ice.anomaly_detection.models.base.BaseAnomalyDetection.fit">fit() (ice.anomaly_detection.models.base.BaseAnomalyDetection method)</a>
 
       <ul>
-        <li><a href="reference/ice.html#ice.base.BaseModel.fit">(ice.base.BaseModel method)</a>, <a href="reference/index.html#ice.base.BaseModel.fit">[1]</a>
+        <li><a href="reference/ice.base.html#ice.base.BaseModel.fit">(ice.base.BaseModel method)</a>, <a href="reference/ice.html#ice.base.BaseModel.fit">[1]</a>
 </li>
       </ul></li>
-      <li><a href="reference/ice.html#ice.base.BaseModel.from_config">from_config() (ice.base.BaseModel class method)</a>, <a href="reference/index.html#ice.base.BaseModel.from_config">[1]</a>
+      <li><a href="reference/ice.base.html#ice.base.BaseModel.from_config">from_config() (ice.base.BaseModel class method)</a>, <a href="reference/ice.html#ice.base.BaseModel.from_config">[1]</a>
 </li>
   </ul></td>
 </tr></table>
@@ -526,7 +526,7 @@ <h2 id="I">I</h2>
     ice.base
 
       <ul>
-        <li><a href="reference/ice.html#module-ice.base">module</a>, <a href="reference/index.html#module-ice.base">[1]</a>
+        <li><a href="reference/ice.base.html#module-ice.base">module</a>, <a href="reference/ice.html#module-ice.base">[1]</a>
 </li>
       </ul></li>
       <li>
@@ -678,7 +678,7 @@ <h2 id="M">M</h2>
 </li>
         <li><a href="reference/ice.anomaly_detection.html#module-ice.anomaly_detection.utils">ice.anomaly_detection.utils</a>
 </li>
-        <li><a href="reference/ice.html#module-ice.base">ice.base</a>, <a href="reference/index.html#module-ice.base">[1]</a>
+        <li><a href="reference/ice.base.html#module-ice.base">ice.base</a>, <a href="reference/ice.html#module-ice.base">[1]</a>
 </li>
         <li><a href="reference/ice.configs.html#module-ice.configs">ice.configs</a>
 </li>
@@ -739,7 +739,7 @@ <h2 id="P">P</h2>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="reference/ice.configs.html#ice.configs.Config.path_set">path_set() (ice.configs.Config method)</a>
 </li>
-      <li><a href="reference/ice.html#ice.base.BaseModel.predict">predict() (ice.base.BaseModel method)</a>, <a href="reference/index.html#ice.base.BaseModel.predict">[1]</a>
+      <li><a href="reference/ice.base.html#ice.base.BaseModel.predict">predict() (ice.base.BaseModel method)</a>, <a href="reference/ice.html#ice.base.BaseModel.predict">[1]</a>
 </li>
   </ul></td>
 </tr></table>
@@ -766,7 +766,7 @@ <h2 id="S">S</h2>
       <ul>
         <li><a href="reference/ice.anomaly_detection.html#ice.anomaly_detection.datasets.AnomalyDetectionSmallTEP.set_name_public_link">(ice.anomaly_detection.datasets.AnomalyDetectionSmallTEP method)</a>
 </li>
-        <li><a href="reference/ice.html#ice.base.BaseDataset.set_name_public_link">(ice.base.BaseDataset method)</a>, <a href="reference/index.html#ice.base.BaseDataset.set_name_public_link">[1]</a>
+        <li><a href="reference/ice.base.html#ice.base.BaseDataset.set_name_public_link">(ice.base.BaseDataset method)</a>, <a href="reference/ice.html#ice.base.BaseDataset.set_name_public_link">[1]</a>
 </li>
         <li><a href="reference/ice.fault_diagnosis.html#ice.fault_diagnosis.datasets.FaultDiagnosisReinartzTEP.set_name_public_link">(ice.fault_diagnosis.datasets.FaultDiagnosisReinartzTEP method)</a>
 </li>

diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/py-modindex.html b/docs/py-modindex.html
@@ -379,7 +379,7 @@ <h1>Python Module Index</h1>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
-       <a href="reference/index.html#module-ice.base"><code class="xref">ice.base</code></a></td><td>
+       <a href="reference/ice.base.html#module-ice.base"><code class="xref">ice.base</code></a></td><td>
        <em></em></td></tr>
      <tr class="cg-1">
        <td></td>

diff --git a/docs/reference/ice.anomaly_detection.html b/docs/reference/ice.anomaly_detection.html
@@ -325,6 +325,7 @@
      aria-label="Section Navigation">
   <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
   <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="ice.base.html">Base modules</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="ice.fault_diagnosis.html">Fault Diagnosis</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="ice.fault_diagnosis.models.html">Models</a></li>
 </ul>
@@ -432,7 +433,7 @@ <h2>Models<a class="headerlink" href="#models" title="Permalink to this heading"
 <dl class="py class">
 <dt class="sig sig-object py" id="ice.anomaly_detection.datasets.AnomalyDetectionReinartzTEP">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ice.anomaly_detection.datasets.</span></span><span class="sig-name descname"><span class="pre">AnomalyDetectionReinartzTEP</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_chunks</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force_download</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ice.anomaly_detection.datasets.AnomalyDetectionReinartzTEP" title="Permalink to this definition">#</a></dt>
-<dd><p>Bases: <a class="reference internal" href="index.html#ice.base.BaseDataset" title="ice.base.BaseDataset"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseDataset</span></code></a></p>
+<dd><p>Bases: <a class="reference internal" href="ice.base.html#ice.base.BaseDataset" title="ice.base.BaseDataset"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseDataset</span></code></a></p>
 <p>Dataset of Tennessee Eastman Process based on the paper Reinartz, C.,
 Kulahci, M., &amp; Ravn, O. (2021). An extended Tennessee Eastman simulation
 dataset for fault-detection and decision support systems. Computers &amp;
@@ -463,7 +464,7 @@ <h2>Models<a class="headerlink" href="#models" title="Permalink to this heading"
 <dl class="py class">
 <dt class="sig sig-object py" id="ice.anomaly_detection.datasets.AnomalyDetectionSmallTEP">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ice.anomaly_detection.datasets.</span></span><span class="sig-name descname"><span class="pre">AnomalyDetectionSmallTEP</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_chunks</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force_download</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ice.anomaly_detection.datasets.AnomalyDetectionSmallTEP" title="Permalink to this definition">#</a></dt>
-<dd><p>Bases: <a class="reference internal" href="index.html#ice.base.BaseDataset" title="ice.base.BaseDataset"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseDataset</span></code></a></p>
+<dd><p>Bases: <a class="reference internal" href="ice.base.html#ice.base.BaseDataset" title="ice.base.BaseDataset"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseDataset</span></code></a></p>
 <p>Cropped version of Tennessee Eastman Process dataset
 Rieth, C. A., Amsel, B. D., Tran, R., &amp; Cook, M. B. (2017).
 Additional Tennessee Eastman Process Simulation Data for

diff --git a/docs/reference/ice.anomaly_detection.models.html b/docs/reference/ice.anomaly_detection.models.html
@@ -325,6 +325,7 @@
      aria-label="Section Navigation">
   <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
   <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="ice.base.html">Base modules</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="ice.fault_diagnosis.html">Fault Diagnosis</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="ice.fault_diagnosis.models.html">Models</a></li>
 </ul>
@@ -409,7 +410,7 @@ <h1>Anomaly detection models<a class="headerlink" href="#anomaly-detection-model
 <dl class="py class">
 <dt class="sig sig-object py" id="ice.anomaly_detection.models.base.BaseAnomalyDetection">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ice.anomaly_detection.models.base.</span></span><span class="sig-name descname"><span class="pre">BaseAnomalyDetection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">window_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">batch_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_epochs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">threshold</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.95</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ice.anomaly_detection.models.base.BaseAnomalyDetection" title="Permalink to this definition">#</a></dt>
-<dd><p>Bases: <a class="reference internal" href="index.html#ice.base.BaseModel" title="ice.base.BaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseModel</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
+<dd><p>Bases: <a class="reference internal" href="ice.base.html#ice.base.BaseModel" title="ice.base.BaseModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseModel</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
 <p>Base class for all anomaly detection models.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="ice.anomaly_detection.models.base.BaseAnomalyDetection.__init__">