mssm commited on
Commit
f67deb2
1 Parent(s): b1c0080

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +32 -1
README.md CHANGED
@@ -1,10 +1,41 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  title: Chatbots
3
  emoji: 💬
4
  colorFrom: yellow
5
  colorTo: purple
6
  sdk: gradio
7
- sdk_version: 4.36.1
8
  app_file: app.py
9
  pinned: false
10
  ---
 
1
+ ## How to Contribute Your Chatbot
2
+
3
+ 1. **Fork the Repository**
4
+ - Go to our GitHub repository and fork it to your own GitHub account.
5
+
6
+ 2. **Clone Your Fork**
7
+ - Clone your fork to your local machine.
8
+
9
+ 3. **Add Your Chatbot**
10
+ - In the `app.py` file, add your chatbot's integration.
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's functionality.
15
+
16
+ 5. **Submit a Pull Request**
17
+ - Once satisfied with your chatbot integration, push your changes to your fork and submit a pull request to the main repository.
18
+
19
+ 6. **Review Process**
20
+ - Your submission will be reviewed by our team. Please be available for any questions or required changes.
21
+
22
+ ## Example Code for Adding a Chatbot
23
+
24
+ ```python
25
+ from huggingface_hub import InferenceClient
26
+
27
+ 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
  ---