deploy: f648d63

rajivsam · Feb 22, 2024 · befb549 · befb549
commit befb549
Show file tree

Hide file tree

Showing 71 changed files with 9,650 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +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: 7b6dcb4b0f066381e96a9682db7d2bbb
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/kmds.doctree b/.doctrees/kmds.doctree
diff --git a/.doctrees/kmds.ontology.doctree b/.doctrees/kmds.ontology.doctree
diff --git a/.doctrees/kmds.pipelines.doctree b/.doctrees/kmds.pipelines.doctree
diff --git a/.doctrees/kmds.tagging.doctree b/.doctrees/kmds.tagging.doctree
diff --git a/.doctrees/kmds.utils.doctree b/.doctrees/kmds.utils.doctree
diff --git a/.doctrees/modules.doctree b/.doctrees/modules.doctree
diff --git a/.nojekyll b/.nojekyll
diff --git a/_modules/index.html b/_modules/index.html
@@ -0,0 +1,108 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="../">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Overview: module code &mdash; KMDS 0.2.7 documentation</title>
+      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
+
+
+  <!--[if lt IE 9]>
+    <script src="../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script src="../_static/jquery.js?v=5d32c60e"></script>
+        <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="../_static/documentation_options.js?v=58050c01"></script>
+        <script src="../_static/doctools.js?v=888ff710"></script>
+        <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../index.html" class="icon icon-home">
+            KMDS
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../modules.html">kmds</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">KMDS</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Overview: module code</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="kmds/ontology/kmds_ontology.html">kmds.ontology.kmds_ontology</a></li>
+<li><a href="kmds/pipelines/retail_processing.html">kmds.pipelines.retail_processing</a></li>
+<li><a href="kmds/tagging/tag_types.html">kmds.tagging.tag_types</a></li>
+<li><a href="kmds/utils/config_reader.html">kmds.utils.config_reader</a></li>
+<li><a href="kmds/utils/load_utils.html">kmds.utils.load_utils</a></li>
+<li><a href="kmds/utils/path_utils.html">kmds.utils.path_utils</a></li>
+</ul>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, Rajiv Sambasivan.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/_modules/kmds/ontology/kmds_ontology.html b/_modules/kmds/ontology/kmds_ontology.html
diff --git a/_modules/kmds/pipelines/retail_processing.html b/_modules/kmds/pipelines/retail_processing.html
diff --git a/_modules/kmds/tagging/tag_types.html b/_modules/kmds/tagging/tag_types.html
@@ -0,0 +1,170 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="../../../">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>kmds.tagging.tag_types &mdash; KMDS 0.2.7 documentation</title>
+      <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
+
+
+  <!--[if lt IE 9]>
+    <script src="../../../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script src="../../../_static/jquery.js?v=5d32c60e"></script>
+        <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="../../../_static/documentation_options.js?v=58050c01"></script>
+        <script src="../../../_static/doctools.js?v=888ff710"></script>
+        <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../../../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../../../genindex.html" />
+    <link rel="search" title="Search" href="../../../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../../../index.html" class="icon icon-home">
+            KMDS
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../modules.html">kmds</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../../../index.html">KMDS</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
+          <li class="breadcrumb-item"><a href="../../index.html">Module code</a></li>
+      <li class="breadcrumb-item active">kmds.tagging.tag_types</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>Source code for kmds.tagging.tag_types</h1><div class="highlight"><pre>
+<span></span><span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Enum</span>
+
+<div class="viewcode-block" id="ExploratoryTags">
+<a class="viewcode-back" href="../../../kmds.tagging.html#kmds.tagging.tag_types.ExploratoryTags">[docs]</a>
+<span class="k">class</span> <span class="nc">ExploratoryTags</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">Enum</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot; Tags to capture the exploratory observation type</span>
+
+<span class="sd">    Args:</span>
+<span class="sd">        str (_type_): string type tag</span>
+<span class="sd">        Enum (_type_): string type tag</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">RELEVANCE_OBSERVATION</span> <span class="o">=</span> <span class="s2">&quot;Relevance Observation&quot;</span> 
+    <span class="n">DATA_QUALITY_OBSERVATION</span> <span class="o">=</span> <span class="s2">&quot;Data Quality Observation&quot;</span></div>
+
+
+<div class="viewcode-block" id="DataRepresentationTags">
+<a class="viewcode-back" href="../../../kmds.tagging.html#kmds.tagging.tag_types.DataRepresentationTags">[docs]</a>
+<span class="k">class</span> <span class="nc">DataRepresentationTags</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">Enum</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot; Tags to capture the data representation observation type</span>
+<span class="sd">    Args:</span>
+<span class="sd">        str (_type_): string type tag</span>
+<span class="sd">        Enum (_type_): string type tag</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">FEATURE_ENGG_OBSERVATION</span> <span class="o">=</span> <span class="s2">&quot;Feature Engineering Observation&quot;</span>
+    <span class="n">DATA_TRANSFORMATION_OBSERVATION</span> <span class="o">=</span> <span class="s2">&quot;Data Transformation Observation&quot;</span></div>
+
+
+<div class="viewcode-block" id="ModellingChoiceTags">
+<a class="viewcode-back" href="../../../kmds.tagging.html#kmds.tagging.tag_types.ModellingChoiceTags">[docs]</a>
+<span class="k">class</span> <span class="nc">ModellingChoiceTags</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">Enum</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot; Tags corresponding to Modelling choice observation type</span>
+<span class="sd">    Args:</span>
+<span class="sd">        str (_type_): string type tag</span>
+<span class="sd">        Enum (_type_): string type tag</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">MODELLING_CHOICE_OBSERVATION</span> <span class="o">=</span> <span class="s2">&quot;Modelling Choice Observation&quot;</span>
+    <span class="n">MODELLING_ASSUMPTION_OBSERVATION</span> <span class="o">=</span> <span class="s2">&quot;Modelling Assumption Observation&quot;</span></div>
+
+
+<div class="viewcode-block" id="ExperimentationTags">
+<a class="viewcode-back" href="../../../kmds.tagging.html#kmds.tagging.tag_types.ExperimentationTags">[docs]</a>
+<span class="k">class</span> <span class="nc">ExperimentationTags</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">Enum</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot; Tags corresponding to experimentation observation type</span>
+<span class="sd">    Args:</span>
+<span class="sd">        str (_type_): string type tag</span>
+<span class="sd">        Enum (_type_): string type tag</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">HYPOTHESIS_STATEMENT</span> <span class="o">=</span> <span class="s2">&quot;Hypothesis Statement&quot;</span>
+    <span class="n">EXPERIMENTAL_OBSERVATION</span> <span class="o">=</span> <span class="s2">&quot;Experimental Observation&quot;</span>
+    <span class="n">EXPERIMENTAL_CONJECTURE</span> <span class="o">=</span> <span class="s2">&quot;Experimental Conjecture&quot;</span>
+    <span class="n">RESULT_SUMMARY</span> <span class="o">=</span> <span class="s2">&quot;Experimental Result Summary&quot;</span></div>
+
+
+<div class="viewcode-block" id="ModelSelectionTags">
+<a class="viewcode-back" href="../../../kmds.tagging.html#kmds.tagging.tag_types.ModelSelectionTags">[docs]</a>
+<span class="k">class</span> <span class="nc">ModelSelectionTags</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">Enum</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot; Tags corresponding to Model Selection observation type</span>
+<span class="sd">    Args:</span>
+<span class="sd">        str (_type_): string type tag</span>
+<span class="sd">        Enum (_type_): string type tag</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">MODEL_SELECTION_STATEMENT</span> <span class="o">=</span> <span class="s2">&quot;Model Selection Statement&quot;</span>
+    <span class="n">MODEL_SELECTION_SETUP_DESCRIPTION</span> <span class="o">=</span> <span class="s2">&quot;Model Selection Setup Description&quot;</span>
+    <span class="n">MODEL_SELECTION_OBSERVATION</span> <span class="o">=</span> <span class="s2">&quot;Model Selection Observation&quot;</span>
+    <span class="n">MODEL_SELECTION_RESULT_SUMMARY</span> <span class="o">=</span> <span class="s2">&quot;Model Selection Result Summary&quot;</span></div>
+
+
+</pre></div>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, Rajiv Sambasivan.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>