-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #100 from edubotics-ai/dev_branch
Dev branch
- Loading branch information
Showing
1 changed file
with
24 additions
and
73 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,90 +1,41 @@ | ||
| --- | ||
| title: AI Class Tutor | ||
| description: An LLM based AI class tutor with RAG on DL4DS course | ||
| emoji: 🐶 | ||
| colorFrom: red | ||
| colorTo: green | ||
| sdk: docker | ||
| app_port: 7860 | ||
| --- | ||
| # DL4DS Tutor 🏃 | ||
| # edubotics-core | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
| ## Welcome to edubotics-core by Edubotics AI! 👋 | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
| [](https://github.com/edubotics-ai/edubot-core/graphs/contributors) | ||
|
|
||
| Check out the configuration reference at [Hugging Face Spaces Config Reference](https://huggingface.co/docs/hub/spaces-config-reference). | ||
| **Empower Education with AI: Create Intelligent Chatbots Quickly and Efficiently 🚀** | ||
|
|
||
| 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`. | ||
| edubotics-core is an open-source Python library that allows developers to build LLM-based chatbots efficiently. It provides a comprehensive set of core modules for vector storage, retrieval, processing, with more to come. | ||
|
|
||
| ## 🛠 Installation | ||
|
|
||
| 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`. | ||
| You can install edubotics-core using pip: | ||
|
|
||
| ## 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/edubotics-ai/edubot-core | ||
| ``` | ||
|
|
||
| 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 edubotics_core.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 edubotics_core.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 | ||
| ```bash | ||
| pip install edubotics-core | ||
| ``` | ||
|
|
||
| Please visit the [docs](https://dl4ds.github.io/dl4ds_tutor/) for more information. | ||
| Full documentation can be found [here](https://edubotics-ai.github.io/edubot-core/). | ||
|
|
||
| ## ✨ Key Features | ||
| - Modular and Extensible: Easily create, modify, and extend to the core modules. | ||
|
|
||
| ## Docker | ||
|
|
||
| The HuggingFace Space is built using the `Dockerfile` in the repository. To run it locally, use the `Dockerfile.dev` file. | ||
| ## 📚 Applications | ||
|
|
||
| ```bash | ||
| docker build --tag dev -f Dockerfile.dev . | ||
| docker run -it --rm -p 7860:7860 dev | ||
| ``` | ||
| To see the full extent of what edubotics-core can do, check out the app templates we have built: | ||
|
|
||
| ## Contributing | ||
| - [Edubotics AI Tutor](https://github.com/edubotics-ai/edubot-app): A Digital AI Teaching Assistant setup for the [DS598](https://dl4ds.github.io/sp2024/) course at Boston University. | ||
|
|
||
| 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`. | ||
| ## 💁 Contributing | ||
|
|
||
| Please visit [contribute](https://dl4ds.github.io/dl4ds_tutor/guide/contribute/) for more information on contributing. | ||
| We welcome contributions to edubotics-core! If you're interested in contributing, please check out our [contributing guidelines](CONTRIBUTING.md) for more details. | ||
|
|
||
| ## Future Work | ||
| ## 📜 License | ||
|
|
||
| For more information on future work, please visit [roadmap](https://dl4ds.github.io/dl4ds_tutor/guide/readmap/). | ||
| edubotics-core is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details. |