Hugging Face's logo

Spaces:
dl4ds
/
tutor_dev
Configuration error

App Files Community
XThomasBU commited on
Commit
82e12ec
·
1 Parent(s): b7d3eda

readme update

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