Skip to content

Commit

Permalink
update readme, further road to V2
Browse files Browse the repository at this point in the history
  • Loading branch information
gustavz committed Aug 30, 2023
1 parent 78c93f7 commit 74062ea
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 10 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# DataChad 🤖
# DataChad V2🤖

This is an app that let's you ask questions about any data source by leveraging [embeddings](https://platform.openai.com/docs/guides/embeddings), [vector databases](https://www.activeloop.ai/), [large language models](https://platform.openai.com/docs/models/gpt-3-5) and last but not least [langchains](https://github.com/hwchase17/langchain)

Expand All @@ -17,15 +17,13 @@ This is an app that let's you ask questions about any data source by leveraging
- As default context this git repository is taken so you can directly start asking question about its functionality without chosing an own data source.
- To run locally or deploy somewhere, execute `cp .env.template .env` and set credentials in the newly created `.env` file. Other options are manually setting of system environment variables, or storing them into `.streamlit/secrets.toml` when hosted via streamlit.
- If you have credentials set like explained above, you can just hit `submit` in the authentication without reentering your credentials in the app.
- To enable `Local Mode` (disabled for the demo) set `ENABLE_LOCAL_MODE` to `True` in `datachad/constants.py`. You need to have the model binaries downloaded and stored inside `./models/`
- Currently supported `Local Mode` OSS model is [GPT4all](https://gpt4all.io/models/ggml-gpt4all-j-v1.3-groovy.bin). To add more models update `datachad/models.py`
- If you are running `Local Mode` all your data stays locally on your machine. No API calls are made. Same with the embeddings database which stores its data to `./data/`
- Your data won't load? Feel free to open an Issue or PR and contribute!
- Yes, Chad in `DataChad` refers to the well-known [meme](https://www.google.com/search?q=chad+meme)
- DataChad V2 does not support local mode, but many feature will soon come. Stay tuned!

## How does it look like?

<img src="./datachad.png" width="100%"/>
<img src="./datachadV2.png" width="100%"/>

## TODO LIST
If you like to contribute, feel free to grab any task
Expand All @@ -34,13 +32,17 @@ If you like to contribute, feel free to grab any task
- [x] Enable fully local / private mode
- [x] Add option to upload multiple files to a single dataset
- [x] Decouple datachad modules from streamlit
- [ ] remove all local mode and other V1 stuff
- [x] remove all local mode and other V1 stuff
- [x] Load existing knowledge bases
- [x] Delete existing knowledge bases
- [x] Enable streaming responses
- [x] Show retrieved context
- [ ] Refactor UI
- [ ] Introduce smart FAQs
- [ ] Exchange downloaded file storage with tempfile
- [ ] Add user creation and login
- [ ] Load and delete existing knowledge bases
- [ ] Add chat history per user
- [ ] Make all I/O asynchronous
- [ ] Implement FastAPI routes and backend app
- [ ] Implement a proper frontend (react or whatever)
- [ ] containerize the app
- [ ] deploy the app with k8s
- [ ] Add Image caption and Audio transcription support
2 changes: 1 addition & 1 deletion datachad/streamlit/constants.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
PAGE_ICON = "🤖"
APP_NAME = "DataChad"
APP_NAME = "DataChad V2"
PROJECT_URL = "https://github.com/gustavz/DataChad"
DEFAULT_DATA_SOURCE = "https://github.com/gustavz/DataChad.git"

Expand Down
File renamed without changes
Binary file added datachadV2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 74062ea

Please sign in to comment.