Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

README.md

OpenSSA Framework Library

OpenSSA Key Components

High-Level Class Diagram

OpenSSA High-Level Class Diagram

Package Structure

  • openssa: Root package for OpenSSA.

    • openssa.core: Core functionalities of the SSMs.
      • openssa.deprecated.ssm: Small Specialist Model (SSM) functionality.
        • openssa.deprecated.ssm.openai_ssm: OpenAI API SSM implementations.
        • openssa.deprecated.ssm.huggingface_ssm: HuggingFace API SSM implementations.
      • openssa.deprecated.slm: Component: Small Language Model (SLM) functionality.
        • openssa.deprecated.ssm.openai_slm: OpenAI API SLM implementations.
        • openssa.deprecated.ssm.huggingface_slm: HuggingFace API SLM implementations.
      • openssa.deprecated.adapter: Component: Interface between the SLM and the domain-knowledge backends.
      • openssa.deprecated.backend: Component: Interfaces to a variety of domain-knowledge backends.
      • openssa.deprecated.inferencer: Component: Inference wrapper for models behind SSM backends.
    • openssa.capture: Tools and APIs for capturing and encoding domain knowledge into various backends.
    • openssa.composer: Tools for composing multiple SSMs together.
    • openssa.industrial: Industrial-AI specific tools and APIs (trust, reliability, safety, etc.)
    • openssa.integration: Tools for integrating SSMs into industrial applications.
  • tests: Unit tests for the framework's components (located at the top level of the project).

  • apps: Example applications using SSMs (located at the top level of the project).

  • docs: OpenSSA project documentation (located at the top level of the project).

Getting Started

You can begin contributing to the OpenSSA project or use our pre-trained SSMs for your industrial projects. See our Getting Started Guide for more information.

Community

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 Community Forum.

Contribute

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 Contribution Guide for more details.

License

OpenSSA is released under the Apache 2.0 License.