|
1 |
| ---- |
2 |
| -title: AI Class Tutor |
3 |
| -description: An LLM based AI class tutor with RAG on DL4DS course |
4 |
| -emoji: 🐶 |
5 |
| -colorFrom: red |
6 |
| -colorTo: green |
7 |
| -sdk: docker |
8 |
| -app_port: 7860 |
9 |
| ---- |
10 |
| -# DL4DS Tutor 🏃 |
| 1 | +# edubotics-core |
11 | 2 |
|
12 |
| - |
13 |
| - |
14 |
| - |
15 |
| - |
| 3 | +## Welcome to edubotics-core by Edubotics AI! 👋 |
16 | 4 |
|
| 5 | + |
| 6 | + |
| 7 | + |
| 8 | + |
| 9 | +[](https://github.com/edubotics-ai/edubot-core/graphs/contributors) |
17 | 10 |
|
18 |
| -Check out the configuration reference at [Hugging Face Spaces Config Reference](https://huggingface.co/docs/hub/spaces-config-reference). |
| 11 | +**Empower Education with AI: Create Intelligent Chatbots Quickly and Efficiently 🚀** |
19 | 12 |
|
20 |
| -You can find a "production" implementation of the Tutor running live at [DL4DS Tutor](https://dl4ds-dl4ds-tutor.hf.space/) from the |
21 |
| -Hugging Face [Space](https://huggingface.co/spaces/dl4ds/dl4ds_tutor). It is pushed automatically from the `main` branch of this repo by this |
22 |
| -[Actions Workflow](https://github.com/DL4DS/dl4ds_tutor/blob/main/.github/workflows/push_to_hf_space.yml) upon a push to `main`. |
| 13 | +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. |
23 | 14 |
|
| 15 | +## 🛠 Installation |
24 | 16 |
|
25 |
| -A "development" version of the Tutor is running live at [DL4DS Tutor -- Dev](https://dl4ds-tutor-dev.hf.space/) from this Hugging Face |
26 |
| -[Space](https://huggingface.co/spaces/dl4ds/tutor_dev). It is pushed automatically from the `dev_branch` branch of this repo by this |
27 |
| -[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`. |
| 17 | +You can install edubotics-core using pip: |
28 | 18 |
|
29 |
| -## Setup |
30 |
| - |
31 |
| -Please visit [setup](https://dl4ds.github.io/dl4ds_tutor/guide/setup/) for more information on setting up the project. |
32 |
| - |
33 |
| -## Running Locally |
34 |
| - |
35 |
| -1. **Clone the Repository** |
36 |
| - ```bash |
37 |
| - git clone https://github.com/edubotics-ai/edubot-core |
38 |
| - ``` |
39 |
| - |
40 |
| -2. Create your app in the apps folder. (An example is the `apps/ai_tutor` app) |
41 |
| - ``` |
42 |
| - cd apps |
43 |
| - mkdir your_app |
44 |
| - ``` |
45 |
| - |
46 |
| -2. **Put your data under the `apps/your_app/storage/data` directory** |
47 |
| - - Add URLs in the `urls.txt` file. |
48 |
| - - Add other PDF files in the `apps/your_app/storage/data` directory. |
49 |
| - |
50 |
| -3. **To test Data Loading (Optional)** |
51 |
| - ```bash |
52 |
| - cd apps/your_app |
53 |
| - python -m edubotics_core.dataloader.data_loader --links "your_pdf_link" --config_file config/config.yml --project_config_file config/project_config.yml |
54 |
| - ``` |
55 |
| - |
56 |
| -4. **Create the Vector Database** |
57 |
| - ```bash |
58 |
| - cd apps/your_app |
59 |
| - python -m edubotics_core.vectorstore.store_manager --config_file config/config.yml --project_config_file config/project_config.yml |
60 |
| - ``` |
61 |
| - |
62 |
| -6. **Run the FastAPI App** |
63 |
| - ```bash |
64 |
| - cd apps/your_app |
65 |
| - uvicorn app:app --port 7860 |
66 |
| - ``` |
67 |
| - |
68 |
| -## Documentation |
| 19 | +```bash |
| 20 | +pip install edubotics-core |
| 21 | +``` |
69 | 22 |
|
70 |
| -Please visit the [docs](https://dl4ds.github.io/dl4ds_tutor/) for more information. |
| 23 | +Full documentation can be found [here](https://edubotics-ai.github.io/edubot-core/). |
71 | 24 |
|
| 25 | +## ✨ Key Features |
| 26 | +- Modular and Extensible: Easily create, modify, and extend to the core modules. |
72 | 27 |
|
73 |
| -## Docker |
74 | 28 |
|
75 |
| -The HuggingFace Space is built using the `Dockerfile` in the repository. To run it locally, use the `Dockerfile.dev` file. |
| 29 | +## 📚 Applications |
76 | 30 |
|
77 |
| -```bash |
78 |
| -docker build --tag dev -f Dockerfile.dev . |
79 |
| -docker run -it --rm -p 7860:7860 dev |
80 |
| -``` |
| 31 | +To see the full extent of what edubotics-core can do, check out the app templates we have built: |
81 | 32 |
|
82 |
| -## Contributing |
| 33 | +- [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. |
83 | 34 |
|
84 |
| -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`. |
| 35 | +## 💁 Contributing |
85 | 36 |
|
86 |
| -Please visit [contribute](https://dl4ds.github.io/dl4ds_tutor/guide/contribute/) for more information on contributing. |
| 37 | +We welcome contributions to edubotics-core! If you're interested in contributing, please check out our [contributing guidelines](CONTRIBUTING.md) for more details. |
87 | 38 |
|
88 |
| -## Future Work |
| 39 | +## 📜 License |
89 | 40 |
|
90 |
| -For more information on future work, please visit [roadmap](https://dl4ds.github.io/dl4ds_tutor/guide/readmap/). |
| 41 | +edubotics-core is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details. |
0 commit comments