Spaces:
Running
Running
Update README.md
Browse files
README.md
CHANGED
@@ -1,23 +1,37 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
## How to Contribute Your Chatbot
|
2 |
|
3 |
1. **Fork the Repository**
|
4 |
-
-
|
5 |
|
6 |
2. **Clone Your Fork**
|
7 |
- Clone your fork to your local machine.
|
8 |
|
9 |
3. **Add Your Chatbot**
|
10 |
-
-
|
11 |
-
- If using a Hugging Face model, specify the model ID in the appropriate section.
|
12 |
|
13 |
4. **Test Your Chatbot**
|
14 |
-
- Run the application locally and test your chatbot
|
15 |
|
16 |
5. **Submit a Pull Request**
|
17 |
-
-
|
18 |
|
19 |
6. **Review Process**
|
20 |
-
- Your submission will be reviewed
|
21 |
|
22 |
## Example Code for Adding a Chatbot
|
23 |
|
@@ -28,16 +42,3 @@ client = InferenceClient("your-huggingface-model-id")
|
|
28 |
|
29 |
def respond(message, history, system_message, max_tokens, temperature, top_p):
|
30 |
# Your chatbot logic here
|
31 |
-
|
32 |
-
---
|
33 |
-
title: Chatbots
|
34 |
-
emoji: 💬
|
35 |
-
colorFrom: yellow
|
36 |
-
colorTo: purple
|
37 |
-
sdk: gradio
|
38 |
-
sdk_version: 4.39.0
|
39 |
-
app_file: app.py
|
40 |
-
pinned: false
|
41 |
-
---
|
42 |
-
|
43 |
-
An example chatbot using [Gradio](https://gradio.app), [`huggingface_hub`](https://huggingface.co/docs/huggingface_hub/v0.22.2/en/index), and the [Hugging Face Inference API](https://huggingface.co/docs/api-inference/index).
|
|
|
1 |
+
---
|
2 |
+
title: Your Chatbot Space Title
|
3 |
+
emoji: 💬
|
4 |
+
colorFrom: blue
|
5 |
+
colorTo: green
|
6 |
+
sdk: gradio
|
7 |
+
sdk_version: "3.30.0" # Replace with the version of Gradio you are using
|
8 |
+
app_file: app.py
|
9 |
+
pinned: false
|
10 |
+
---
|
11 |
+
|
12 |
+
# Welcome to Vector Database Cloud Chatbot Space
|
13 |
+
|
14 |
+
This space hosts a variety of chatbots built using different models. Users can interact with the chatbots and even contribute their own by following the guidelines below.
|
15 |
+
|
16 |
## How to Contribute Your Chatbot
|
17 |
|
18 |
1. **Fork the Repository**
|
19 |
+
- Fork this repository to your own GitHub account.
|
20 |
|
21 |
2. **Clone Your Fork**
|
22 |
- Clone your fork to your local machine.
|
23 |
|
24 |
3. **Add Your Chatbot**
|
25 |
+
- Modify the `app.py` file to integrate your chatbot. Ensure you include the necessary configurations for your model.
|
|
|
26 |
|
27 |
4. **Test Your Chatbot**
|
28 |
+
- Run the application locally and test the functionality of your chatbot.
|
29 |
|
30 |
5. **Submit a Pull Request**
|
31 |
+
- Push your changes to your fork and submit a pull request for review.
|
32 |
|
33 |
6. **Review Process**
|
34 |
+
- Your submission will be reviewed and, if accepted, merged into the main repository.
|
35 |
|
36 |
## Example Code for Adding a Chatbot
|
37 |
|
|
|
42 |
|
43 |
def respond(message, history, system_message, max_tokens, temperature, top_p):
|
44 |
# Your chatbot logic here
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|