Installation

Set up

pip3 install llmware or, if you prefer clone the github repo locally, e.g., git clone git@github.com:llmware-ai/llmware.git .

Platforms:

Mac M1/M2/M3, Windows, Linux (Ubuntu 20 or Ubuntu 22 preferred)
RAM: 16 GB minimum
Python 3.9, 3.10, 3.11 (note: not supported on 3.12 - coming soon!)
Pull the latest version of llmware == 0.2.11 (as of end of April 2024)
Please note that we have updated the examples from the original versions, to use new features in llmware, so there may be minor differences with the videos, which are annotated in the comments in each example.

Wheel Archive

If you prefer, we also provide a set of recent wheels in the wheel archives in this repository, which can be downloaded individually and used as follows:

pip3 install llmware-0.2.12-py3-none-any.wheel

We generally keep the main branch of this repository current with all changes, but we only publish new wheels to PyPi approximately once per week

Cloning the Repository

If you prefer to clone the repository:

git clone git@github.com:llmware-ai/llmware.git

The llmware package is contained entirely in the /llmware folder path, so you should be able to drop this folder (with all of its contents) into a project tree, and use the llmware module essentially the same as a pip install.
Please ensure that you are capturing and updating the /llmware/lib folder, which includes required compiled shared libraries. If you prefer, you can keep only those libs required for your OS platform.
After cloning the repo, we provide a short ‘welcome to llmware’ automation script, which can be used to install the projects requirements (from llmware/requirements.txt), install several optional dependencies that are commonly used in examples, copy several good ‘getting started’ examples into the root folder, and then run a ‘welcome_example.py’ script to get started using our models. To use the “welcome to llmware” script:

Windows:

.\welcome_to_llmware_windows.sh

Mac/Linux:

sh ./welcome_to_llmware.sh

More information about the project - see main repository

About the project

Contributing

Please first discuss any change you want to make publicly, for example on GitHub via raising an issue or starting a new discussion. You can also write an email or start a discussion on our Discrod channel. Read more about becoming a contributor in the GitHub repo.

Code of conduct

We welcome everyone into the llmware community. View our Code of Conduct in our GitHub repository.

`llmware` and AI Bloks

llmware is an open source project from AI Bloks - the company behind llmware. The company offers a Software as a Service (SaaS) Retrieval Augmented Generation (RAG) service. AI Bloks was founded by Namee Oberst and Darren Oberst in October 2022.

License

llmware is distributed by an Apache-2.0 license.