Metadata-Version: 2.1
Name: openssa
Version: 0.23.12.10
Summary: OpenSSA - Small Specialist Agents for Industrial AI
Home-page: https://openssa.org
License: Apache-2.0
Keywords: Artificial Intelligence,A.I.,AI,industrial,specialist,specialized,domain,expertise,knowledge
Author: Aitomatic, Inc.
Author-email: engineering@aitomatic.com
Maintainer: Aitomatic, Inc.
Maintainer-email: engineering@aitomatic.com
Requires-Python: >=3.10,<3.12
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Provides-Extra: contrib
Provides-Extra: cv
Provides-Extra: lint
Provides-Extra: test
Requires-Dist: adlfs (>=2023.10,<2023.12)
Requires-Dist: click (>=8.1)
Requires-Dist: docx2txt (>=0.8)
Requires-Dist: fsspec (>=2023.10,<2023.12)
Requires-Dist: gcsfs (>=2023.10,<2023.12)
Requires-Dist: google-api-python-client (>=2.109)
Requires-Dist: httpx (>=0.25)
Requires-Dist: llama-hub (>=0.0.55)
Requires-Dist: llama-index (>=0.9)
Requires-Dist: openai (>=1.3)
Requires-Dist: pillow (>=9.5) ; extra == "cv"
Requires-Dist: pycryptodome (>=3.19)
Requires-Dist: pydantic (>=2.5)
Requires-Dist: pylint (>=3.0) ; extra == "lint"
Requires-Dist: pypdf (>=3.17)
Requires-Dist: pytest (>=7.4) ; extra == "test"
Requires-Dist: python-dotenv (>=1.0)
Requires-Dist: python-pptx (>=0.6) ; extra == "cv"
Requires-Dist: s3fs (>=2023.10,<2023.12)
Requires-Dist: streamlit (>=1.29) ; extra == "contrib"
Requires-Dist: streamlit-mic-recorder (>=0.0.4) ; extra == "contrib"
Requires-Dist: torch (>=2.0) ; extra == "cv"
Requires-Dist: transformers (>=4.35) ; extra == "cv"
Project-URL: Documentation, https://aitomatic.github.io/openssa
Project-URL: Repository, https://github.com/aitomatic/openssa
Description-Content-Type: text/markdown

# OpenSSA – Small Specialist Agents for Industrial AI

> __Documentation__: [aitomatic.github.io/openssa](https://aitomatic.github.io/openssa)
>
> __Installation__: `pip install openssa` _(Python 3.10-3.11)_
>
> __SSA Problem-Solver App Launcher__ _(after installation by `pip install openssa[contrib]`)_: `openssa launch solver`
> (try out the same app hosted at [openssa.streamlit.app](https://openssa.streamlit.app))

OpenSSA is an open-source framework for Small Specialist Agents (SSAs), problem-solving AI agents for industrial applications. Harnessing the power of human domain expertise, SSAs operate either alone or in collaborative "teams", and can integrate with both informational and operational sensors/actuators to deliver real-world industrial AI solutions.

SSAs are light-weight, domain-focused and incorporate reasoning and planning capabilities. These characteristics make them ideal for complex hierarchical tasks typically found in industrial applications.


## Small Size, Specific-Domain Specialization

The trend towards specialization in AI models is a clear trajectory seen by many in the field.

<!-- markdownlint-disable MD028 -->
> &nbsp;
> _Specialization is crucial for quality .. not general purpose Al models_ – Eric Schmidt, Schmidt Foundation
> &nbsp;

> &nbsp;
> _.. small models .. for a specific task that are good_ –  Matei Zaharia, Databricks
> &nbsp;

> &nbsp;
> _.. small agents working together .. specific and best in their tasks_ – Harrison Chase, Langchain
> &nbsp;

> &nbsp;
> _.. realize that smaller, cheaper, more specialized models make more sense for 99% of AI use-cases .._ – Clem Delangue, Hugging Face
> &nbsp;

> &nbsp;
> _.. small but highly capable expert models_ – Andrej Karpathy, OpenAI
> &nbsp;

> &nbsp;
> _.. small models are .. a massive paradigm shift .. about deploying AI models at scale_ – Rob Toews, Radical Ventures
> &nbsp;
<!-- markdownlint-enable MD028 -->

As predicted by Eric Schmidt and others, we will see “a rich ecosystem to emerge [of] high-value, specialized AI systems.” SSAs are the central part in the architecture of these systems.


## System-1 & System-2 Intelligence

In addition to information-retrieval and inferencing ("System-1 intelligence") capabilities, SSAs are additionally designed with hierachical reasoning and planning ("System-2 intelligence") capabilities. They can execute tasks following general-purpose problem-solving paradigms (such as OODA) and domain-specific expert heuristics, in order to solve a diverse variery of problems that are hard for System-1-only Large Language Models (LLMs) and traditional AI models.


## SSA vs LLM

Unlike LLMs, which are computationally intensive and generalized, SSAs are lean, efficient, and designed specifically for individual domains. This focus makes them an optimal choice for businesses, SMEs, researchers, and developers seeking specialized and robust AI solutions for industrial applications.

- **Fast, Cost-Effective & Easy to Use:** SSAs are 100-1000x faster and more efficient than LLMs, making them accessible and cost-effective particularly for industrial usage where time and resources are critical factors.

- **Industrial Focus:** SSAs are developed with a specific emphasis on industrial applications, addressing the unique requirements of trustworthiness, safety, reliability, and scalability inherent to this sector.

- **System-1 AND System-2 Capabilities, not just System-1:** On top of System-1 capabilities such as knowledge query and inferencing/prediction, SSAs have hierarchical problem-solving capabilities based on the domain-specific knowledge and expert heuristics.

- **Vendor Independence:** OpenSSA allows everyone to build, train, and deploy their own domain-expert AI models, offering freedom from vendor lock-in and security concerns.


## Target Audience

Our primary audience includes:

- **Businesses and SMEs** wishing to leverage AI in their specific industrial context without relying on extensive computational resources or large vendor solutions.

- **AI researchers and developers** keen on creating more efficient, robust, and domain-specific AI agents for industrial applications.

- **Open-source contributors** believing in democratizing industrial AI and eager to contribute to a community-driven project focused on building and sharing specialized AI agents.

- **Industries** with specific domain problems that can be tackled more effectively by a specialist AI agent, enhancing the reliability and trustworthiness of AI solutions in an industrial setting.


## SSA Architecture


## Getting Started

See our [Getting Started Guide](docs/GETTING_STARTED.md) for more information.


## Roadmap


## Community

Join our vibrant community of AI enthusiasts, researchers, developers, and businesses who are democratizing industrial AI through SSAs.  Participate in the discussions, share your ideas, or ask for help on our [Community Discussions](https://github.com/aitomatic/openssa/discussions).


## Contribute

OpenSSA is a community-driven initiative, and we warmly welcome contributions. Whether it's enhancing existing models, creating new SSAs for different industrial domains, or improving our documentation, every contribution counts. See our [Contribution Guide](docs/community/CONTRIBUTING.md) for more details.


## License

OpenSSA is released under the [Apache 2.0 License](docs/LICENSE.md).

