mirror of
https://github.com/wassname/Open-Assistant.git
synced 2026-07-03 17:10:10 +08:00
Yannic Kilcher
73 lines
2.7 KiB
Markdown
73 lines
2.7 KiB
Markdown
# 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.
|
||
|
||
## How can you help?
|
||
|
||
All open source projects begins with people like you. Open source is the belief that if we collaborate we can together gift our knowledge and technology to the world for the benefit of humanity.
|
||
|
||
## I’m in! Now what?
|
||
|
||
[Fill out the contributor signup form](https://docs.google.com/forms/d/e/1FAIpQLSeuggO7UdYkBvGLEJldDvxp6DwaRbW5p7dl96UzFkZgziRTrQ/viewform)
|
||
|
||
[Join the LAION Discord Server!](https://discord.gg/RQFtmAmk)
|
||
|
||
[Visit the Notion](https://ykilcher.com/open-assistant)
|
||
|
||
## Developer Setup
|
||
|
||
Work is organized in the [project board](https://github.com/orgs/LAION-AI/projects/3).
|
||
|
||
**Anything that is in the `Todo` column and not assigned, is up for grabs. Meaning we'd be happy if anyone did those tasks.**
|
||
|
||
If you want to work on something, assign yourself to it or write a comment that you want to work on it and what you plan to do.
|
||
|
||
- To get started with development, if you want to work on the backend, have a look at `scripts/backend-development/README.md`.
|
||
- If you want to work on any frontend, have a look at `scripts/frontend-development/README.md` to make a backend available.
|
||
|
||
There is also a minimal implementation of a frontend in the `text-frontend` folder.
|
||
|
||
We are using Python 3.10 for the backend.
|
||
|
||
Check out the [High-Level Protocol Architecture](https://www.notion.so/High-Level-Protocol-Architecture-6f1fd3551da74213b560ead369f132dc)
|
||
|
||
### Website
|
||
|
||
The website is built using Next.js and is in the `website` folder.
|
||
|
||
### Pre-commit
|
||
|
||
Install `pre-commit` and run `pre-commit install` to install the pre-commit hooks.
|
||
|
||
In case you haven't done this, have already committed, and CI is failing, you can run `pre-commit run --all-files` to run the pre-commit hooks on all files.
|
||
|
||
# (Older version of the readme below)
|
||
|
||
## How do I start helping out?
|
||
|
||
Check out these pages to learn more about the project.
|
||
|
||
Ping Birger on discord if you want help to get started.
|
||
|
||
http://**discordapp.com/users/birger#6875**
|
||
|
||
## More information in the notion
|
||
|
||
https://roan-iguanadon-a58.notion.site/Open-Chat-Gpt-83dd217eeeb84907a155b8a9d716fa46
|
||
|
||
## Code structure
|
||
|
||
### Bot
|
||
|
||
We have a folder named bot where code related to the bot lives.
|
||
|
||
### Backend
|
||
|
||
We have a backend folder for backend development of the api that the discord bot sends it information to.
|
||
|
||
### Website
|
||
|
||
We have a folder for the website, live at https://projects.laion.ai/Open-Chat-GPT/ .The website is built using Next.js
|