wassname/Open-Assistant
1
0
Fork 0
mirror of https://github.com/wassname/Open-Assistant.git synced 2026-09-09 11:15:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #122 from MohamedAliRashad/main

Browse Source 
Slightly better README.md
This commit is contained in:
Yannic Kilcher
2022-12-29 21:41:05 +01:00
committed by GitHub
parent ad5f8a5a52 74209da90b
commit 665ab862a6
1 changed files with 15 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+15 -14
View File
@@ -4,6 +4,21 @@ Open Assistant is a project meant to give everyone access to a great chat based
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. 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.
## Do you want to try ?
If you are interested in taking a look at the current state of the project, You can set up an entire stack needed to run **Open-Assistant**, including the
website, backend, and associated dependent services.
To start the demo, Run this in the root directory of the repository:
```sh
docker compose up --build
```
Then, navigate to `http://localhost:3000` (It may take some time to boot up) and interact with the website.
**Note:** When logging in, navigate to `http://localhost:1080` to get the magic email login link.
## The Plan ## The Plan
We want to get to an initial MVP as fast as possible, by following the 3-steps outlined in the InstructGPT paper. We want to get to an initial MVP as fast as possible, by following the 3-steps outlined in the InstructGPT paper.
@@ -95,20 +110,6 @@ 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) Check out the [High-Level Protocol Architecture](https://www.notion.so/High-Level-Protocol-Architecture-6f1fd3551da74213b560ead369f132dc)
## End to End Demo
If you are interested in just taking a look at the project.
You can set up an entire stack needed to run Open Assistant, including the
website, backend, and associated dependent services.
To start the demo, run this, in root directory:
```sh
docker compose up --build
```
Then, navigate to `http://localhost:3000` and interact with the website.
### Website ### Website
The website is built using Next.js and is in the `website` folder. The website is built using Next.js and is in the `website` folder.