Skip to content

Commit

Permalink
update GitHub Pages documentation site
Browse files Browse the repository at this point in the history
  • Loading branch information
@TheVinhLuong102
TheVinhLuong102 committed Mar 13, 2024
1 parent 013314b commit 0c8da52
Show file tree
Hide file tree
Showing 129 changed files with 10,392 additions and 1,242 deletions.
4 changes: 2 additions & 2 deletions GETTING_STARTED.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<link rel="stylesheet" href="_static/theme.css " type="text/css" />

<!-- sphinx script_files -->
<script src="_static/documentation_options.js?v=9e72b9a1"></script>
<script src="_static/documentation_options.js?v=d1d0e38f"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>

Expand Down Expand Up @@ -154,7 +154,7 @@ <h2>Links<a class="headerlink" href="#links" title="Link to this heading">¶</a>
<div class="page-nav">
<div class="inner"><ul class="page-nav">
</ul><div class="footer" role="contentinfo">
&#169; Copyright 2023, Aitomatic, Inc. &lt;engineering@aitomatic.com&gt;.
&#169; Copyright 2024, Aitomatic, Inc. &lt;engineering@aitomatic.com&gt;.
<br>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.2.6 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a> 0.8.0.
</div>
Expand Down
4 changes: 2 additions & 2 deletions LICENSE.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<link rel="stylesheet" href="_static/theme.css " type="text/css" />

<!-- sphinx script_files -->
<script src="_static/documentation_options.js?v=9e72b9a1"></script>
<script src="_static/documentation_options.js?v=d1d0e38f"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>

Expand Down Expand Up @@ -270,7 +270,7 @@
<div class="page-nav">
<div class="inner"><ul class="page-nav">
</ul><div class="footer" role="contentinfo">
&#169; Copyright 2023, Aitomatic, Inc. &lt;engineering@aitomatic.com&gt;.
&#169; Copyright 2024, Aitomatic, Inc. &lt;engineering@aitomatic.com&gt;.
<br>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.2.6 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a> 0.8.0.
</div>
Expand Down
4 changes: 2 additions & 2 deletions PROJECT_PHILOSOPHY.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<link rel="stylesheet" href="_static/theme.css " type="text/css" />

<!-- sphinx script_files -->
<script src="_static/documentation_options.js?v=9e72b9a1"></script>
<script src="_static/documentation_options.js?v=d1d0e38f"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>

Expand Down Expand Up @@ -104,7 +104,7 @@ <h1>OpenSSA Project Philosophy<a class="headerlink" href="#openssa-project-philo
<div class="page-nav">
<div class="inner"><ul class="page-nav">
</ul><div class="footer" role="contentinfo">
&#169; Copyright 2023, Aitomatic, Inc. &lt;engineering@aitomatic.com&gt;.
&#169; Copyright 2024, Aitomatic, Inc. &lt;engineering@aitomatic.com&gt;.
<br>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.2.6 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a> 0.8.0.
</div>
Expand Down
2 changes: 1 addition & 1 deletion _static/documentation_options.js
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '0.23.12.18',
VERSION: '0.24.3.6',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
1,140 changes: 989 additions & 151 deletions genindex.html
View file

Large diffs are not rendered by default.

173 changes: 48 additions & 125 deletions index.html
View file

Large diffs are not rendered by default.

306 changes: 228 additions & 78 deletions modules.html
View file

Large diffs are not rendered by default.

11 changes: 3 additions & 8 deletions openssa.contrib.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<link rel="stylesheet" href="_static/theme.css " type="text/css" />

<!-- sphinx script_files -->
<script src="_static/documentation_options.js?v=9e72b9a1"></script>
<script src="_static/documentation_options.js?v=d1d0e38f"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>

Expand Down Expand Up @@ -93,12 +93,6 @@
<li><p>Candidate implementations of integrations</p></li>
<li><p>Reusable application components and/or templates (e.g., Gradio, Streamlit, etc.)</p></li>
</ul>
<dl class="py attribute">
<dt class="sig sig-object py" id="openssa.contrib.StreamlitSSAProbSolver">
<span class="sig-prename descclassname"><span class="pre">openssa.contrib.</span></span><span class="sig-name descname"><span class="pre">StreamlitSSAProbSolver</span></span><a class="headerlink" href="#openssa.contrib.StreamlitSSAProbSolver" title="Link to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="openssa.contrib.streamlit_ssa_prob_solver.html#openssa.contrib.streamlit_ssa_prob_solver.SSAProbSolver" title="openssa.contrib.streamlit_ssa_prob_solver.SSAProbSolver"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSAProbSolver</span></code></a></p>
</dd></dl>

<section id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this heading"></a></h2>
<div class="toctree-wrapper compound">
Expand All @@ -124,6 +118,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
<li class="toctree-l3"><a class="reference internal" href="openssa.contrib.streamlit_ssa_prob_solver.html#openssa.contrib.streamlit_ssa_prob_solver.SSAProbSolver.ssa_solve"><code class="docutils literal notranslate"><span class="pre">SSAProbSolver.ssa_solve()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="openssa.contrib.streamlit_ssa_prob_solver.html#openssa.contrib.streamlit_ssa_prob_solver.update_multiselect_style"><code class="docutils literal notranslate"><span class="pre">update_multiselect_style()</span></code></a></li>
</ul>
</li>
</ul>
Expand All @@ -136,7 +131,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
<div class="page-nav">
<div class="inner"><ul class="page-nav">
</ul><div class="footer" role="contentinfo">
&#169; Copyright 2023, Aitomatic, Inc. &lt;engineering@aitomatic.com&gt;.
&#169; Copyright 2024, Aitomatic, Inc. &lt;engineering@aitomatic.com&gt;.
<br>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.2.6 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a> 0.8.0.
</div>
Expand Down
19 changes: 12 additions & 7 deletions openssa.contrib.streamlit_ssa_prob_solver.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<link rel="stylesheet" href="_static/theme.css " type="text/css" />

<!-- sphinx script_files -->
<script src="_static/documentation_options.js?v=9e72b9a1"></script>
<script src="_static/documentation_options.js?v=d1d0e38f"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>

Expand Down Expand Up @@ -90,7 +90,7 @@
<p>SSA Problem-Solver Streamlit Component.</p>
<dl class="py class">
<dt class="sig sig-object py" id="openssa.contrib.streamlit_ssa_prob_solver.SSAProbSolver">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">openssa.contrib.streamlit_ssa_prob_solver.</span></span><span class="sig-name descname"><span class="pre">SSAProbSolver</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">unique_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">UUID</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">domain</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">problem</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expert_instructions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fine_tuned_model_url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doc_src_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doc_src_file_relpaths</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">frozenset</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></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">frozenset({})</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openssa.contrib.streamlit_ssa_prob_solver.SSAProbSolver" title="Link to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">openssa.contrib.streamlit_ssa_prob_solver.</span></span><span class="sig-name descname"><span class="pre">SSAProbSolver</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">unique_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Uid</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">domain</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">problem</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expert_instructions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fine_tuned_model_url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doc_src_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DirOrFilePath</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">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">doc_src_file_relpaths</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">FilePathSet</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">frozenset({})</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openssa.contrib.streamlit_ssa_prob_solver.SSAProbSolver" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>SSA Problem-Solver Streamlit Component.</p>
<dl class="py attribute">
Expand All @@ -105,7 +105,7 @@

<dl class="py attribute">
<dt class="sig sig-object py" id="openssa.contrib.streamlit_ssa_prob_solver.SSAProbSolver.DocSrcHash">
<span class="sig-name descname"><span class="pre">DocSrcHash</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">type</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">str</span> <span class="pre">|</span> <span class="pre">frozenset[str]</span></em><a class="headerlink" href="#openssa.contrib.streamlit_ssa_prob_solver.SSAProbSolver.DocSrcHash" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">DocSrcHash</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">DocSrcHash</span></em><a class="headerlink" href="#openssa.contrib.streamlit_ssa_prob_solver.SSAProbSolver.DocSrcHash" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
Expand All @@ -130,7 +130,7 @@

<dl class="py attribute">
<dt class="sig sig-object py" id="openssa.contrib.streamlit_ssa_prob_solver.SSAProbSolver.Uid">
<span class="sig-name descname"><span class="pre">Uid</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">type</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">int</span> <span class="pre">|</span> <span class="pre">str</span> <span class="pre">|</span> <span class="pre">uuid.UUID</span></em><a class="headerlink" href="#openssa.contrib.streamlit_ssa_prob_solver.SSAProbSolver.Uid" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">Uid</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">Uid</span></em><a class="headerlink" href="#openssa.contrib.streamlit_ssa_prob_solver.SSAProbSolver.Uid" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py method">
Expand All @@ -140,12 +140,12 @@

<dl class="py property">
<dt class="sig sig-object py" id="openssa.contrib.streamlit_ssa_prob_solver.SSAProbSolver.doc_src_file_relpaths">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">doc_src_file_relpaths</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">frozenset</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#openssa.contrib.streamlit_ssa_prob_solver.SSAProbSolver.doc_src_file_relpaths" title="Link to this definition"></a></dt>
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">doc_src_file_relpaths</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">FilePathSet</span></em><a class="headerlink" href="#openssa.contrib.streamlit_ssa_prob_solver.SSAProbSolver.doc_src_file_relpaths" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="openssa.contrib.streamlit_ssa_prob_solver.SSAProbSolver.doc_src_path">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">doc_src_path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#openssa.contrib.streamlit_ssa_prob_solver.SSAProbSolver.doc_src_path" title="Link to this definition"></a></dt>
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">doc_src_path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">DirOrFilePath</span></em><a class="headerlink" href="#openssa.contrib.streamlit_ssa_prob_solver.SSAProbSolver.doc_src_path" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py property">
Expand Down Expand Up @@ -181,14 +181,19 @@

</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="openssa.contrib.streamlit_ssa_prob_solver.update_multiselect_style">
<span class="sig-prename descclassname"><span class="pre">openssa.contrib.streamlit_ssa_prob_solver.</span></span><span class="sig-name descname"><span class="pre">update_multiselect_style</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#openssa.contrib.streamlit_ssa_prob_solver.update_multiselect_style" title="Link to this definition"></a></dt>
<dd></dd></dl>

</section>


</div>
<div class="page-nav">
<div class="inner"><ul class="page-nav">
</ul><div class="footer" role="contentinfo">
&#169; Copyright 2023, Aitomatic, Inc. &lt;engineering@aitomatic.com&gt;.
&#169; Copyright 2024, Aitomatic, Inc. &lt;engineering@aitomatic.com&gt;.
<br>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.2.6 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a> 0.8.0.
</div>
Expand Down
4 changes: 2 additions & 2 deletions openssa.core.adapter.abstract_adapter.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<link rel="stylesheet" href="_static/theme.css " type="text/css" />

<!-- sphinx script_files -->
<script src="_static/documentation_options.js?v=9e72b9a1"></script>
<script src="_static/documentation_options.js?v=d1d0e38f"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>

Expand Down Expand Up @@ -177,7 +177,7 @@
<div class="page-nav">
<div class="inner"><ul class="page-nav">
</ul><div class="footer" role="contentinfo">
&#169; Copyright 2023, Aitomatic, Inc. &lt;engineering@aitomatic.com&gt;.
&#169; Copyright 2024, Aitomatic, Inc. &lt;engineering@aitomatic.com&gt;.
<br>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.2.6 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a> 0.8.0.
</div>
Expand Down
4 changes: 2 additions & 2 deletions openssa.core.adapter.base_adapter.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<link rel="stylesheet" href="_static/theme.css " type="text/css" />

<!-- sphinx script_files -->
<script src="_static/documentation_options.js?v=9e72b9a1"></script>
<script src="_static/documentation_options.js?v=d1d0e38f"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>

Expand Down Expand Up @@ -191,7 +191,7 @@
<div class="page-nav">
<div class="inner"><ul class="page-nav">
</ul><div class="footer" role="contentinfo">
&#169; Copyright 2023, Aitomatic, Inc. &lt;engineering@aitomatic.com&gt;.
&#169; Copyright 2024, Aitomatic, Inc. &lt;engineering@aitomatic.com&gt;.
<br>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.2.6 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a> 0.8.0.
</div>
Expand Down
Loading

0 comments on commit 0c8da52

Please sign in to comment.