README

Open-Assistant
  



:memo: NOTE: OpenAssistant is completed, and the project is now finished. Thank you to everyone who contributed! Check out our blog post for more information. The final published oasst2 dataset can be found on HuggingFace at OpenAssistant/oasst2




!GitHub Repo stars
!Docs
!GitHub Workflow Status
!GitHub Workflow Status
!GitHub Workflow Status
!GitHub Workflow Status
!GitHub Workflow Status
!GitHub Workflow Status
!GitHub Workflow Status
!GitHub Workflow Status
!GitHub release (latest by date)
!Translate



 Table of Contents

- What is Open Assistant?
- Useful Links
- How To Try It Out
- The Vision
- The Plan
- How You Can Help

---

 What is Open Assistant?


Open Assistant is a project meant to give everyone access to a great chat based
large language model.


We believe that by doing this we will create a revolution in innovation in
language. In the same way that stable-diffusion helped the world make art and
images in new ways we hope Open Assistant can help improve the world by
improving language itself.

 Useful Links

- Data Collection

- Chat

- Project Documentation

 How To Try It Out

 Chatting with the AI

The chat frontend is now live here. Log in and
start chatting! Please try to react with a thumbs up or down for the assistant's
responses when chatting.

 Contributing to Data Collection

The data collection frontend is now live here. Log
in and start taking on tasks! We want to collect a high volume of quality data.
By submitting, ranking, and labelling model prompts and responses you will be
directly helping to improve the capabilities of Open Assistant.

 Running the Development Setup Locally (without chat)

You do not need to run the project locally unless you are contributing to the
development process. The website link above will take you to the public website
where you can use the data collection app and the chat.

If you would like to run the data collection app locally for development, you
can set up an entire stack needed to run Open-Assistant, including the
website, backend, and associated dependent services, with Docker.

To start the demo, run this in the root directory of the repository (check
this FAQ
if you have problems):

sh
docker compose --profile ci up --build --attach-dependencies


 Note: when running on MacOS with an M1 chip you have to use:
 DB_PLATFORM=linux/x86_64 docker compose ...

Then, navigate to http://localhost:3000 (It may take some time to boot up) and
interact with the website.

 Note: If an issue occurs with the build, please head to the
 FAQ and check out the
 entries about Docker.

 Note: When logging in via email, navigate to http://localhost:1080 to
 get the magic email login link.

 Note: If you would like to run this in a standardized development
 environment (a
 "devcontainer")
 using
 vscode locally
 or in a web browser using
 GitHub Codespaces, you can use the
 provided .devcontainer folder.

 Running the Development Setup Locally for Chat

You do not need to run 

Top issues

Discussions

Latest release

Full Changelog: https://github.com/LAION-AI/Open-Assistant/compare/v0.0.4-alpha1...v0.0.4-alpha2

 build fixes by @yk