-
Notifications
You must be signed in to change notification settings - Fork 46
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update GitHub Pages documentation site
- Loading branch information
1 parent
5d9aa38
commit cf64ae2
Showing
87 changed files
with
5,647 additions
and
5,977 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,7 +10,7 @@ | |
<link rel="stylesheet" href="_static/theme.css " type="text/css" /> | ||
|
||
<!-- sphinx script_files --> | ||
<script src="_static/documentation_options.js?v=ce85efbf"></script> | ||
<script src="_static/documentation_options.js?v=f043a128"></script> | ||
<script src="_static/doctools.js?v=9a2dae69"></script> | ||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script> | ||
|
||
|
@@ -156,7 +156,7 @@ <h2>Links<a class="headerlink" href="#links" title="Link to this heading">¶</a> | |
</ul><div class="footer" role="contentinfo"> | ||
© Copyright 2024, Aitomatic, Inc. <[email protected]>. | ||
<br> | ||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.3.7 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a> 0.9.1. | ||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.0.2 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a> 0.9.1. | ||
</div> | ||
</div> | ||
</div> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,7 +10,7 @@ | |
<link rel="stylesheet" href="_static/theme.css " type="text/css" /> | ||
|
||
<!-- sphinx script_files --> | ||
<script src="_static/documentation_options.js?v=ce85efbf"></script> | ||
<script src="_static/documentation_options.js?v=f043a128"></script> | ||
<script src="_static/doctools.js?v=9a2dae69"></script> | ||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script> | ||
|
||
|
@@ -273,7 +273,7 @@ | |
</ul><div class="footer" role="contentinfo"> | ||
© Copyright 2024, Aitomatic, Inc. <[email protected]>. | ||
<br> | ||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.3.7 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a> 0.9.1. | ||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.0.2 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a> 0.9.1. | ||
</div> | ||
</div> | ||
</div> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,13 +4,13 @@ | |
<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>OpenSSA: Small Specialist Agents for Problem-Solving</title> | ||
<title>OpenSSA: Neurosymbolic Agentic AI for Industrial Problem-Solving</title> | ||
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> | ||
<link rel="stylesheet" href="_static/theme.css " type="text/css" /> | ||
|
||
<!-- sphinx script_files --> | ||
<script src="_static/documentation_options.js?v=ce85efbf"></script> | ||
<script src="_static/documentation_options.js?v=f043a128"></script> | ||
<script src="_static/doctools.js?v=9a2dae69"></script> | ||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script> | ||
|
||
|
@@ -74,7 +74,7 @@ | |
<ul class="breadcrumbs"> | ||
<li><a href="#">Docs</a> »</li> | ||
|
||
<li><code class="docutils literal notranslate"><span class="pre">OpenSSA</span></code>: Small Specialist Agents for Problem-Solving</li> | ||
<li>OpenSSA: Neurosymbolic Agentic AI for Industrial Problem-Solving</li> | ||
</ul> | ||
|
||
|
||
|
@@ -85,41 +85,38 @@ | |
<hr> | ||
<div class="content" role="main" v-pre> | ||
|
||
<!-- markdownlint-disable MD013 MD043 --> | ||
<section id="openssa-small-specialist-agents-for-problem-solving"> | ||
<h1><code class="docutils literal notranslate"><span class="pre">OpenSSA</span></code>: Small Specialist Agents for Problem-Solving<a class="headerlink" href="#openssa-small-specialist-agents-for-problem-solving" title="Link to this heading">¶</a></h1> | ||
<p><code class="docutils literal notranslate"><span class="pre">OpenSSA</span></code> is an agentic AI framework for solving complex problems in real-world industry domains, | ||
overcoming the limitations of LLMs and RAG in such settings.</p> | ||
<section id="level-2-intelligence-with-planning-reasoning-domain-specific-knowledge-and-diverse-informational-resources"> | ||
<h2>Level-2 Intelligence with Planning, Reasoning, domain-specific Knowledge and diverse Informational Resources<a class="headerlink" href="#level-2-intelligence-with-planning-reasoning-domain-specific-knowledge-and-diverse-informational-resources" title="Link to this heading">¶</a></h2> | ||
<p><code class="docutils literal notranslate"><span class="pre">OpenSSA</span></code> agents, built with powerful Hierarchical Task Planning (HTP) and Observe-Orient-Decide-Act Reasoning (OODAR), | ||
go far beyond the Level-1 pattern-matching intelligence performed by LLMs and RAG and achieve superior outcomes | ||
in complex multi-faceted, multi-step tasks. See our <a class="reference external" href="https://arxiv.org/abs/2404.11792">comparative study</a>.</p> | ||
<p><code class="docutils literal notranslate"><span class="pre">OpenSSA</span></code> agents can also be armed with domain-specific Knowledge, connected to diverse Informational Resources | ||
(files, databases, web sources, etc.), and/or be guided by specialized industry experts | ||
to maximize the accuracy and comprehensiveness in their planning, reasoning and deliberative/iterative problem-solving.</p> | ||
</section> | ||
<section id="open-and-extensible-architecture"> | ||
<h2>Open and Extensible Architecture<a class="headerlink" href="#open-and-extensible-architecture" title="Link to this heading">¶</a></h2> | ||
<p>Committed to promoting and supporting open development in generative AI, | ||
<code class="docutils literal notranslate"><span class="pre">OpenSSA</span></code> would strive to integrate with a diverse array of LLM backends, especially open-source LLMs. | ||
If you would like certain LLMs to be supported, please suggest through a GitHub issue, or, even better, submit your PRs.</p> | ||
<p>Additionally, <code class="docutils literal notranslate"><span class="pre">OpenSSA</span></code>’s key Planning, Reasoning, Knowledge and Resource interfaces | ||
are designed with customizability and extensibility as first-class concerns, | ||
in order to enable developers to effectively solve problems in their specific industries and specialized domains.</p> | ||
</section> | ||
<section id="small-and-resource-efficient-agents-for-practical-real-world-deployment"> | ||
<h2>Small and Resource-Efficient Agents for Practical Real-World Deployment<a class="headerlink" href="#small-and-resource-efficient-agents-for-practical-real-world-deployment" title="Link to this heading">¶</a></h2> | ||
<p>Specialized, Level-2 intelligence allows <code class="docutils literal notranslate"><span class="pre">OpenSSA</span></code> agents to work well in many applications | ||
using significantly smaller component models, thereby greatly economizing computing resources.</p> | ||
<!-- markdownlint-disable MD013 MD043 MD050 --> | ||
<section id="openssa-neurosymbolic-agentic-ai-for-industrial-problem-solving"> | ||
<h1>OpenSSA: Neurosymbolic Agentic AI for Industrial Problem-Solving<a class="headerlink" href="#openssa-neurosymbolic-agentic-ai-for-industrial-problem-solving" title="Link to this heading">¶</a></h1> | ||
<p><strong>Why OpenSSA?</strong> | ||
OpenSSA is an open-source neurosymbolic agentic AI framework | ||
designed to solve complex, high-stakes problems in industries like semiconductor, manufacturing and finance, | ||
where consistency, accuracy and deterministic outcomes are essential.</p> | ||
<p>At the core of OpenSSA is the <strong>Domain-Aware Neurosymbolic Agent (DANA)</strong> architecture, | ||
advancing AI from basic pattern-matching and information retrieval to true problem-solving. | ||
It overcomes the limitations of traditional LLMs and RAG in high-precision, multi-step problem-solving | ||
by combining <strong>Hierarchical Task Plans (HTPs)</strong> to structure complex programs and the <strong>Observe-Orient-Decide-Act Reasoning (OODAR)</strong> paradigm to execute such programs. | ||
By integrating domain-specific knowledge with neural and symbolic planning and reasoning, | ||
OpenSSA consistently delivers accurate solutions for complex industrial challenges.</p> | ||
<section id="key-benefits-of-openssa"> | ||
<h2>Key Benefits of OpenSSA<a class="headerlink" href="#key-benefits-of-openssa" title="Link to this heading">¶</a></h2> | ||
<ul class="simple"> | ||
<li><p><strong>Consistent Results</strong>: Delivers repeatable, high-precision outcomes for complex tasks.</p></li> | ||
<li><p><strong>Advanced Problem-Solving</strong>: Combines HTPs and OODAR for multi-step planning and reasoning.</p></li> | ||
<li><p><strong>Scalable Expertise</strong>: Leverages domain knowledge to scale AI without heavy data requirements.</p></li> | ||
<li><p><strong>Resource Efficiency</strong>: Uses smaller, resource-efficient models, minimizing computational costs.</p></li> | ||
<li><p><strong>Extensible and Developer-Friendly</strong>: Supports diverse LLM backends and is fully customizable for industry-specific needs.</p></li> | ||
</ul> | ||
</section> | ||
<section id="getting-started"> | ||
<h2>Getting Started<a class="headerlink" href="#getting-started" title="Link to this heading">¶</a></h2> | ||
<p>Install by <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">openssa</span></code> (on Python 3.12 only).</p> | ||
<ul class="simple"> | ||
<li><p>for bleeding-edge latest capabilities: <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">https://github.com/aitomatic/openssa/archive/main.zip</span></code></p></li> | ||
<li><p>Install with <strong><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">openssa</span></code></strong> | ||
<em>(supports Python 3.12 and 3.13)</em></p></li> | ||
<li><p>For the latest capabilities: | ||
<strong><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">https://github.com/aitomatic/openssa/archive/main.zip</span></code></strong>.</p></li> | ||
<li><p>Explore the <code class="docutils literal notranslate"><span class="pre">examples/</span></code> directory and developer guides and tutorials on our <a class="reference external" href="https://aitomatic.github.io/openssa">documentation site</a>.</p></li> | ||
</ul> | ||
<p>Explore the <code class="docutils literal notranslate"><span class="pre">examples/</span></code> directory and developer guides and tutorials on our <a class="reference external" href="https://aitomatic.github.io/openssa">documentation site</a>.</p> | ||
</section> | ||
<section id="api-documentation"> | ||
<h2><a class="reference external" href="https://aitomatic.github.io/openssa/modules">API Documentation</a><a class="headerlink" href="#api-documentation" title="Link to this heading">¶</a></h2> | ||
|
@@ -131,7 +128,7 @@ <h2>Contributing<a class="headerlink" href="#contributing" title="Link to this h | |
<li><p>Join the discussion on our <a class="reference external" href="https://github.com/aitomatic/openssa/discussions">Community Forum</a></p></li> | ||
<li><p>Submit pull requests for bug fixes, enhancements, or new features</p></li> | ||
</ul> | ||
<p>For more information, see our <a class="reference internal" href="#CONTRIBUTING.md"><span class="xref myst">Contribution Guide</span></a>.</p> | ||
<p>For detailed guidelines, refer to our <a class="reference internal" href="#CONTRIBUTING.md"><span class="xref myst">Contribution Guide</span></a>.</p> | ||
</section> | ||
</section> | ||
|
||
|
@@ -142,7 +139,7 @@ <h2>Contributing<a class="headerlink" href="#contributing" title="Link to this h | |
</ul><div class="footer" role="contentinfo"> | ||
© Copyright 2024, Aitomatic, Inc. <[email protected]>. | ||
<br> | ||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.3.7 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a> 0.9.1. | ||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.0.2 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a> 0.9.1. | ||
</div> | ||
</div> | ||
</div> | ||
|
Oops, something went wrong.