Spaces:
Build error
Build error
File size: 3,330 Bytes
89c1950 06e224d 89c1950 6161dc5 89c1950 7a233a3 b9be4de 7688fa3 7a233a3 b9be4de 1dd61f7 db6b619 39cbdaa 1dd61f7 2406d86 7a233a3 849b2ae 7a233a3 db6b619 60929fd 7a233a3 60929fd db6b619 9a7da99 60929fd 9a7da99 7a233a3 60929fd 7a233a3 db6b619 e488f16 7a233a3 60929fd e488f16 7a233a3 db6b619 2406d86 7a233a3 2406d86 7f989d6 60929fd 7f989d6 2406d86 1e2550f 2406d86 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
---
title: AI Class Tutor -- Dev
description: An LLM based AI class tutor with RAG on DL4DS course
emoji: 🐶
colorFrom: red
colorTo: green
sdk: docker
app_port: 7860
---
# DL4DS Tutor 🏃
Check out the configuration reference at [Hugging Face Spaces Config Reference](https://huggingface.co/docs/hub/spaces-config-reference).
You can find a "production" implementation of the Tutor running live at [DL4DS Tutor](https://dl4ds-dl4ds-tutor.hf.space/) from the
Hugging Face [Space](https://huggingface.co/spaces/dl4ds/dl4ds_tutor). It is pushed automatically from the `main` branch of this repo by this
[Actions Workflow](https://github.com/DL4DS/dl4ds_tutor/blob/main/.github/workflows/push_to_hf_space.yml) upon a push to `main`.
A "development" version of the Tutor is running live at [DL4DS Tutor -- Dev](https://dl4ds-tutor-dev.hf.space/) from this Hugging Face
[Space](https://huggingface.co/spaces/dl4ds/tutor_dev). It is pushed automatically from the `dev_branch` branch of this repo by this
[Actions Workflow](https://github.com/DL4DS/dl4ds_tutor/blob/dev_branch/.github/workflows/push_to_hf_space_prototype.yml) upon a push to `dev_branch`.
## Setup
Please visit [setup](https://dl4ds.github.io/dl4ds_tutor/guide/setup/) for more information on setting up the project.
## Running Locally
1. **Clone the Repository**
```bash
git clone https://github.com/DL4DS/dl4ds_tutor
```
2. Create your app in the apps folder. (An example is the `apps/ai_tutor` app)
```
cd apps
mkdir your_app
```
2. **Put your data under the `apps/your_app/storage/data` directory**
- Add URLs in the `urls.txt` file.
- Add other PDF files in the `apps/your_app/storage/data` directory.
3. **To test Data Loading (Optional)**
```bash
cd apps/your_app
python -m modules.dataloader.data_loader --links "your_pdf_link" --config_file config/config.yml --project_config_file config/project_config.yml
```
4. **Create the Vector Database**
```bash
cd apps/your_app
python -m modules.vectorstore.store_manager --config_file config/config.yml --project_config_file config/project_config.yml
```
6. **Run the FastAPI App**
```bash
cd apps/your_app
uvicorn app:app --port 7860
```
## Documentation
Please visit the [docs](https://dl4ds.github.io/dl4ds_tutor/) for more information.
## Docker
The HuggingFace Space is built using the `Dockerfile` in the repository. To run it locally, use the `Dockerfile.dev` file.
```bash
docker build --tag dev -f Dockerfile.dev .
docker run -it --rm -p 7860:7860 dev
```
## Contributing
Please create an issue if you have any suggestions or improvements, and start working on it by creating a branch and by making a pull request to the `dev_branch`.
Please visit [contribute](https://dl4ds.github.io/dl4ds_tutor/guide/contribute/) for more information on contributing.
## Future Work
For more information on future work, please visit [roadmap](https://dl4ds.github.io/dl4ds_tutor/guide/readmap/).
|