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 committed Dec 23, 2023
1 parent 9ada80a commit 013314b
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 20 deletions.
25 changes: 13 additions & 12 deletions GETTING_STARTED.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,23 +90,24 @@ <h1>Getting Started with OpenSSA<a class="headerlink" href="#getting-started-wit
<section id="who-are-you">
<h2>Who Are You?<a class="headerlink" href="#who-are-you" title="Link to this heading"></a></h2>
<ol class="arabic simple">
<li><p>An end-user of OpenSSM-based applications</p></li>
<li><p>A developer of applications or services using OpenSSM</p></li>
<li><p>An aspiring contributor to OpenSSM</p></li>
<li><p>A committer to OpenSSM</p></li>
<li><p>An end-user of OpenSSA-based applications</p></li>
<li><p>A developer of applications or services using OpenSSA</p></li>
<li><p>An aspiring contributor to OpenSSA</p></li>
<li><p>A committer to OpenSSA</p></li>
</ol>
</section>
<section id="getting-started-as-an-end-user">
<h2>Getting Started as an End-User<a class="headerlink" href="#getting-started-as-an-end-user" title="Link to this heading"></a></h2>
<p>Go straight to <a class="reference external" href="https://openssa.streamlit.app/">OpenSSA Streamlit app</a> and start building your own SSA with your domain document today!</p>
</section>
<section id="getting-started-as-a-developer">
<h2>Getting Started as a Developer<a class="headerlink" href="#getting-started-as-a-developer" title="Link to this heading"></a></h2>
<p>See some example user programs in the <a class="reference internal" href="#./examples/notebooks"><span class="xref myst">examples/notebooks</span></a> directory. For example, the see the sample use case on ALD semiconductor knowledge, do:</p>
<p>See some example user programs in the <a class="reference internal" href="#./examples/notebooks"><span class="xref myst">examples/notebooks</span></a> directory. For example, to see the sample use case on ALD semiconductor knowledge, do:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>%<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>examples/notebooks
</pre></div>
</div>
<section id="common-make-targets-for-openssm-developers">
<h3>Common <code class="docutils literal notranslate"><span class="pre">make</span></code> targets for OpenSSM developers<a class="headerlink" href="#common-make-targets-for-openssm-developers" title="Link to this heading"></a></h3>
<section id="common-make-targets-for-openssa-developers">
<h3>Common <code class="docutils literal notranslate"><span class="pre">make</span></code> targets for OpenSSA developers<a class="headerlink" href="#common-make-targets-for-openssa-developers" title="Link to this heading"></a></h3>
<p>See <a class="reference internal" href="dev/makefile_info.html"><span class="std std-doc">MAKEFILE</span></a> for more details.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>%<span class="w"> </span>make<span class="w"> </span>clean
%<span class="w"> </span>make<span class="w"> </span>build
Expand All @@ -115,7 +116,7 @@ <h3>Common <code class="docutils literal notranslate"><span class="pre">make</sp

%<span class="w"> </span>make<span class="w"> </span>poetry-init
%<span class="w"> </span>make<span class="w"> </span>poetry-install
%<span class="w"> </span>make<span class="w"> </span>install<span class="w"> </span><span class="c1"># local installation of openssm</span>
%<span class="w"> </span>make<span class="w"> </span>install<span class="w"> </span><span class="c1"># local installation of OpenSSA</span>

%<span class="w"> </span>make<span class="w"> </span>pypi-auth<span class="w"> </span><span class="c1"># only for maintainers</span>
%<span class="w"> </span>make<span class="w"> </span>publish<span class="w"> </span><span class="c1"># only for maintainers</span>
Expand All @@ -125,20 +126,20 @@ <h3>Common <code class="docutils literal notranslate"><span class="pre">make</sp
</section>
<section id="getting-started-as-an-aspiring-contributor">
<h2>Getting Started as an Aspiring Contributor<a class="headerlink" href="#getting-started-as-an-aspiring-contributor" title="Link to this heading"></a></h2>
<p>OpenSSM is a community-driven initiative, and we warmly welcome contributions. Whether it’s enhancing existing models, creating new SSMs for different industrial domains, or improving our documentation, every contribution counts. See our <span class="xref myst">Contribution Guide</span> for more details.</p>
<p>You can begin contributing to the OpenSSM project in the <code class="docutils literal notranslate"><span class="pre">contrib/</span></code> directory.</p>
<p>OpenSSA is a community-driven initiative, and we warmly welcome contributions. Whether it’s enhancing existing models, creating new SSMs for different industrial domains, or improving our documentation, every contribution counts. See our <span class="xref myst">Contribution Guide</span> for more details.</p>
<p>You can begin contributing to the OpenSSA project in the <code class="docutils literal notranslate"><span class="pre">contrib/</span></code> directory.</p>
</section>
<section id="getting-started-as-a-committer">
<h2>Getting Started as a Committer<a class="headerlink" href="#getting-started-as-a-committer" title="Link to this heading"></a></h2>
<p>You already know what to do.</p>
</section>
<section id="community">
<h2>Community<a class="headerlink" href="#community" title="Link to this heading"></a></h2>
<p>Join our vibrant community of AI enthusiasts, researchers, developers, and businesses who are democratizing industrial AI through SSMs. Participate in the discussions, share your ideas, or ask for help on our <a class="reference external" href="https://github.com/aitomatic/openssm/discussions">Community Discussions</a>.</p>
<p>Join our vibrant community of AI enthusiasts, researchers, developers, and businesses who are democratizing industrial AI through SSMs. Participate in the discussions, share your ideas, or ask for help on our <a class="reference external" href="https://github.com/aitomatic/OpenSSA/discussions">Community Discussions</a>.</p>
</section>
<section id="license">
<h2>License<a class="headerlink" href="#license" title="Link to this heading"></a></h2>
<p>OpenSSM is released under the <a class="reference internal" href="LICENSE.html"><span class="std std-doc">Apache 2.0 License</span></a>.</p>
<p>OpenSSA is released under the <a class="reference internal" href="LICENSE.html"><span class="std std-doc">Apache 2.0 License</span></a>.</p>
</section>
<section id="links">
<h2>Links<a class="headerlink" href="#links" title="Link to this heading"></a></h2>
Expand Down
10 changes: 5 additions & 5 deletions PROJECT_PHILOSOPHY.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1"><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>OpenSSM Project Philosophy</title>
<title>OpenSSA Project Philosophy</title>

<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/theme.css " type="text/css" />
Expand Down Expand Up @@ -74,7 +74,7 @@
<ul class="breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>

<li>OpenSSM Project Philosophy</li>
<li>OpenSSA Project Philosophy</li>
</ul>


Expand All @@ -85,9 +85,9 @@
<hr>
<div class="content" role="main" v-pre>

<section id="openssm-project-philosophy">
<h1>OpenSSM Project Philosophy<a class="headerlink" href="#openssm-project-philosophy" title="Link to this heading"></a></h1>
<p>At OpenSSM, we believe in the democratization of AI. Our goal is to create an ecosystem where anyone, regardless of their resources, can have access to efficient and domain-specific AI solutions. We envision a future where AI is not only accessible but also robust, reliable, and trustworthy.</p>
<section id="openssa-project-philosophy">
<h1>OpenSSA Project Philosophy<a class="headerlink" href="#openssa-project-philosophy" title="Link to this heading"></a></h1>
<p>At OpenSSA, we believe in the democratization of AI. Our goal is to create an ecosystem where anyone, regardless of their resources, can have access to efficient and domain-specific AI solutions. We envision a future where AI is not only accessible but also robust, reliable, and trustworthy.</p>
<p>Our project is guided by the following principles:</p>
<ol class="arabic simple">
<li><p><strong>Collaboration:</strong> We aim to foster an environment of collaboration where multiple models can work together to solve complex problems.</p></li>
Expand Down
5 changes: 3 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -153,9 +153,10 @@ <h3>Who Are You?<a class="headerlink" href="#who-are-you" title="Link to this he
<li><p>A committer to OpenSSA</p></li>
</ol>
</section>
<section id="getting-started-as-an-end-user">
<h3>Getting Started as an End-User<a class="headerlink" href="#getting-started-as-an-end-user" title="Link to this heading"></a></h3>
</section>
<section id="getting-started-as-an-end-user">
<h2>Getting Started as an End-User<a class="headerlink" href="#getting-started-as-an-end-user" title="Link to this heading"></a></h2>
<p>Go straight to <a class="reference external" href="https://openssa.streamlit.app/">OpenSSA Streamlit app</a> and start building your own SSA with your domain document today!</p>
<section id="getting-started-as-a-developer">
<h3>Getting Started as a Developer<a class="headerlink" href="#getting-started-as-a-developer" title="Link to this heading"></a></h3>
<p>See some example user programs in the <a class="reference internal" href="#./examples/notebooks"><span class="xref myst">examples/notebooks</span></a> directory. For example, the see the sample use case on ALD semiconductor knowledge, do:</p>
Expand Down
2 changes: 1 addition & 1 deletion openssa.core.ssm.base_ssm.html
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@
<dd><p>Bases: <a class="reference internal" href="openssa.core.ssm.abstract_ssm.html#openssa.core.ssm.abstract_ssm.AbstractSSM" title="openssa.core.ssm.abstract_ssm.AbstractSSM"><code class="xref py py-class docutils literal notranslate"><span class="pre">AbstractSSM</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="openssa.core.ssm.base_ssm.BaseSSM.DEFAULT_CONVERSATION_ID">
<span class="sig-name descname"><span class="pre">DEFAULT_CONVERSATION_ID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'bf05'</span></em><a class="headerlink" href="#openssa.core.ssm.base_ssm.BaseSSM.DEFAULT_CONVERSATION_ID" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">DEFAULT_CONVERSATION_ID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'f136'</span></em><a class="headerlink" href="#openssa.core.ssm.base_ssm.BaseSSM.DEFAULT_CONVERSATION_ID" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py property">
Expand Down

0 comments on commit 013314b

Please sign in to comment.