reverting docs and updating readme file (#65)

Co-authored-by: Mohammed Fazil <mohammed.fazil@softwareag.com>
SoftwareAG · Aug 2, 2023 · 0e7fb67 · 0e7fb67
1 parent 03ea954
commit 0e7fb67
Show file tree

Hide file tree

Showing 120 changed files with 45,114 additions and 5,945 deletions.
diff --git a/.github/workflows/test-master.yml b/.github/workflows/test-master.yml
@@ -20,7 +20,7 @@ jobs:
     strategy:
       matrix:
         os: ['ubuntu-latest', 'windows-latest']
-        python-version: [ '3.8', '3.9', '3.10' ]
+        python-version: [ '3.8', '3.9', '3.10', '3.11']
 
     steps:
     - uses: actions/checkout@v2

diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ Read the documentation at **[Nyoka Documentation](https://softwareag.github.io/n
 
 ## List of libraries and models supported by Nyoka :
 
-### Scikit-Learn:
+### Scikit-Learn (version <= 1.3.0):
 
 #### Models -
 
@@ -74,14 +74,14 @@ Read the documentation at **[Nyoka Documentation](https://softwareag.github.io/n
 *  [`LGBMRegressor`](https://lightgbm.readthedocs.io/en/latest/pythonapi/lightgbm.LGBMRegressor.html)
 
 
-### XGBoost:
+### XGBoost (version <= 1.7.6):
 
 
 *  [`XGBClassifier`](https://xgboost.readthedocs.io/en/release_1.5.0/python/python_api.html#module-xgboost.sklearn)
 *  [`XGBRegressor`](https://xgboost.readthedocs.io/en/release_1.5.0/python/python_api.html#module-xgboost.sklearn)
 
 
-### Statsmodels:
+### Statsmodels (version <= 0.14.0):
 
 
 *  [`tsa.arima_model.ARIMA`](https://github.com/statsmodels/statsmodels/blob/master/statsmodels/tsa/arima_model.py#L1026)

diff --git a/docs/.buildinfo b/docs/.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: 03accd84b224698acf6acb00dd9a2f6f
+config: cd9cd651081c4d496ec0a729bf364d67
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.doctrees/PMML44.doctree b/docs/.doctrees/PMML44.doctree
diff --git a/docs/.doctrees/PMML44Super.doctree b/docs/.doctrees/PMML44Super.doctree
diff --git a/docs/.doctrees/arima.doctree b/docs/.doctrees/arima.doctree
diff --git a/docs/.doctrees/enums.doctree b/docs/.doctrees/enums.doctree
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/exponential_smoothing.doctree b/docs/.doctrees/exponential_smoothing.doctree
diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree
diff --git a/docs/.doctrees/keras_model_to_pmml.doctree b/docs/.doctrees/keras_model_to_pmml.doctree
diff --git a/docs/.doctrees/lag.doctree b/docs/.doctrees/lag.doctree
diff --git a/docs/.doctrees/lgb_to_pmml.doctree b/docs/.doctrees/lgb_to_pmml.doctree
diff --git a/docs/.doctrees/metadata.doctree b/docs/.doctrees/metadata.doctree
diff --git a/docs/.doctrees/pre_process.doctree b/docs/.doctrees/pre_process.doctree
diff --git a/docs/.doctrees/retinanet.doctree b/docs/.doctrees/retinanet.doctree
diff --git a/docs/.doctrees/skl_to_pmml.doctree b/docs/.doctrees/skl_to_pmml.doctree
diff --git a/docs/.doctrees/statsmodels_to_pmml.doctree b/docs/.doctrees/statsmodels_to_pmml.doctree
diff --git a/docs/.doctrees/xgboost_to_pmml.doctree b/docs/.doctrees/xgboost_to_pmml.doctree
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/_modules/enums.html b/docs/_modules/enums.html
diff --git a/docs/_modules/exponential_smoothing.html b/docs/_modules/exponential_smoothing.html
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -1,110 +1,220 @@
+
+
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
 <head>
-  <meta charset="utf-8" />
-  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Overview: module code &mdash; Nyoka 5.5.0 documentation</title>
-      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
-  <!--[if lt IE 9]>
-    <script src="../_static/js/html5shiv.min.js"></script>
-  <![endif]-->
+  <meta charset="utf-8">
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+  <title>Overview: Module code &mdash; Nyoka 4.2.0 documentation</title>
+
+
+
+
+
 
-        <script src="../_static/jquery.js"></script>
-        <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
-        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
-        <script src="../_static/doctools.js"></script>
-        <script src="../_static/sphinx_highlight.js"></script>
-    <script src="../_static/js/theme.js"></script>
+
+
+  <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
+
+
+      <script type="text/javascript">
+          var DOCUMENTATION_OPTIONS = {
+              URL_ROOT:'../',
+              VERSION:'4.2.0',
+              LANGUAGE:'None',
+              COLLAPSE_INDEX:false,
+              FILE_SUFFIX:'.html',
+              HAS_SOURCE:  true,
+              SOURCELINK_SUFFIX: '.txt'
+          };
+      </script>
+        <script type="text/javascript" src="../_static/jquery.js"></script>
+        <script type="text/javascript" src="../_static/underscore.js"></script>
+        <script type="text/javascript" src="../_static/doctools.js"></script>
+
+    <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+
+
+  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" /> 
 </head>
 
-<body class="wy-body-for-nav"> 
+<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"> Nyoka
+
+
 
-          <a href="../index.html" class="icon icon-home">
-            Nyoka
           </a>
+
+
+
+
+              <div class="version">
+                4.2
+              </div>
+
+
+
+
 <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="text" name="q" placeholder="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">
+
+
+        </div>
+
+        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
               <ul>
-<li class="toctree-l1"><a class="reference internal" href="../exponential_smoothing.html">ExponentialSmoothing Exporter Module</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../lgb_to_pmml.html">LightGBM Exporter Module</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../pre_process.html">Pre-Processing Exporter Module</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../skl_to_pmml.html">Scikit-Learn Exporter Module</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../statsmodels_to_pmml.html">Statsmodels Exporter Module</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../xgboost_to_pmml.html">XGBoost Exporter Module</a></li>
+                <li class="toctree-l1"><a class="reference internal" href="../statsmodels_to_pmml.html">Statsmodels Exporter Module</a></li>
+                <li class="toctree-l1"><a class="reference internal" href="../keras_model_to_pmml.html">Keras Exporter Module</a></li>
+                <li class="toctree-l1"><a class="reference internal" href="../retinanet.html">RetinaNet Exporter Module</a></li>
+                <li class="toctree-l1"><a class="reference internal" href="../lgb_to_pmml.html">LightGBM Exporter Module</a></li>
+                <li class="toctree-l1"><a class="reference internal" href="../pre_process.html">Pre-Processing Exporter Module</a></li>
+                <li class="toctree-l1"><a class="reference internal" href="../skl_to_pmml.html">Scikit-Learn Exporter Module</a></li>
+                <li class="toctree-l1"><a class="reference internal" href="../xgboost_to_pmml.html">XGBoost Exporter Module</a></li>
+                <li class="toctree-l1"><a class="reference internal" href="../exponential_smoothing.html">ExponentialSmoothing Exporter Module</a></li>
+                <li class="toctree-l1"><a class="reference internal" href="../preprocess_nyoka.html">Nyoka's Pre-Processing Module</a></li>
+                <li class="toctree-l1"><a class="reference internal" href="../enums.html">Enums Module</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" >
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+      <nav class="wy-nav-top" aria-label="top navigation">
+
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
           <a href="../index.html">Nyoka</a>
+
       </nav>
 
+
       <div class="wy-nav-content">
+
         <div class="rst-content">
-          <div role="navigation" aria-label="Page navigation">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs 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><a href="../index.html">Docs</a> &raquo;</li>
+
+      <li>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="exponential_smoothing.html">ExponentialSmoothing Exporter</a></li>
-    <li><a href="lgb_to_pmml.html">LightGBM Exporter</a></li>
-    <li><a href="pre_process.html">Pre-Processing Exporter</a></li>
-    <li><a href="skl_to_pmml.html">Scikit-Learn Exporter</a></li>
-    <li><a href="statsmodels_to_pmml.html">Statsmodels Exporter</a></li>
-    <li><a href="xgboost_to_pmml.html">XGBoost Exporter</a></li>
+<ul>
+
+<li><a href="statsmodels_to_pmml.html">Statsmodels Exporter</a></li>
+<li><a href="keras_model_to_pmml.html">Keras Exporter</a></li>
+<li><a href="retinanet.html">RetinaNet Exporter</a></li>
+<li><a href="lgb_to_pmml.html">LightGBM Exporter</a></li>
+<li><a href="pre_process.html">Pre-Processing Exporter</a></li>
+<li><a href="skl_to_pmml.html">Scikit-Learn Exporter</a></li>
+<li><a href="xgboost_to_pmml.html">XGBoost Exporter</a></li>
+<li><a href="exponential_smoothing.html">ExponentialSmoothing Exporter</a></li>
+<li><a href="lag.html">Nyoka's Pre-processing</a></li>
+<li><a href="enums.html">Enums</a></li>
+
 </ul>
 
            </div>
+
           </div>
           <footer>
+
 
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, maintainer@nyoka.org.</p>
-  </div>
+    <p>
+        &copy; Copyright 2019, maintainer@nyoka.org
 
-  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>.
-
+    </p>
+  </div>
+  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 
 
 </footer>
+
         </div>
       </div>
+
     </section>
+
   </div>
-  <script>
+
+
+
+  <script type="text/javascript">
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script> 
+  </script>
+
+
+
+
+
 
 </body>
 </html>