Skip to content

Aggregate-Intellect/sherpa

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🤖 SHERPA - THINKING COMPANION

PyPI - Version License: MIT

To see the documentation, visit: https://sherpa-ai.readthedocs.io/

Quick Install

With pip:

pip install sherpa-ai

From source (with poetry):

git clone https://github.com/Aggregate-Intellect/sherpa
cd sherpa/src
poetry install

Some dependencies such as chromadb or sentence-transformers are optional and only required to run some specific functionalities (such as the DocumentSearch action). These dependencies are not install by default. You can either install them separated as needed, all install the entire suite using the --with flag from poetry:

poetry install --with optional

Similarly, you can install dependencies for testing and linting:

poetry install --with optional,test,lint

From source (with pip editable mode):

git clone
cd sherpa/src
pip install -e .

Usage

Please refer to the documentation for the list of tutorials on using Sherpa: https://sherpa-ai.readthedocs.io/en/latest/How_To/tutorials.html

Contributions Guideline

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it’s:

  • Reporting a bug
  • Discussing the current state of the book or the accompanying software
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

To get started, visit: https://sherpa-ai.readthedocs.io/en/latest/How_To/contribute.html