Canstralian commited on
Commit
8bc79e3
Β·
verified Β·
1 Parent(s): 5b52a89

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +84 -2
README.md CHANGED
@@ -4,7 +4,7 @@ emoji: πŸƒ
4
  colorFrom: gray
5
  colorTo: purple
6
  sdk: gradio
7
- sdk_version: 5.11.0
8
  app_file: app.py
9
  pinned: true
10
  license: mit
@@ -12,4 +12,86 @@ thumbnail: >-
12
  https://cdn-uploads.huggingface.co/production/uploads/64fbe312dcc5ce730e763dc6/AAc4-Cn2DNmH61MHTsG1v.jpeg
13
  ---
14
 
15
- 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).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4
  colorFrom: gray
5
  colorTo: purple
6
  sdk: gradio
7
+ sdk_version: 5.12.0
8
  app_file: app.py
9
  pinned: true
10
  license: mit
 
12
  https://cdn-uploads.huggingface.co/production/uploads/64fbe312dcc5ce730e763dc6/AAc4-Cn2DNmH61MHTsG1v.jpeg
13
  ---
14
 
15
+ # Fear of a Black Hat πŸƒ
16
+
17
+ 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).
18
+
19
+ ![Thumbnail](https://cdn-uploads.huggingface.co/production/uploads/64fbe312dcc5ce730e763dc6/AAc4-Cn2DNmH61MHTsG1v.jpeg)
20
+
21
+ ## Overview
22
+
23
+ Fear of a Black Hat is an interactive chatbot that demonstrates the use of Gradio's UI components and the Hugging Face Inference API. The app provides users with an engaging experience where they can chat with an AI model to explore various topics, ask questions, and receive intelligent responses based on the latest NLP technology.
24
+
25
+ This project uses the Gradio SDK version 5.12.0 to create a smooth and responsive web-based interface that makes interacting with the AI chatbot easy and fun.
26
+
27
+ ## Features
28
+
29
+ - **AI-Powered Chatbot**: Engage in intelligent conversations on a variety of topics.
30
+ - **Gradio UI**: Beautiful and responsive web interface.
31
+ - **Hugging Face Inference API**: The backend is powered by Hugging Face models, ensuring high-quality responses.
32
+ - **Real-time Interaction**: Instant responses to your input with minimal delay.
33
+ - **Minimalistic Design**: Sleek and simple UI to focus on the conversation.
34
+
35
+ ## Installation
36
+
37
+ ### Prerequisites
38
+ - Python 3.7+
39
+ - Gradio SDK (v5.12.0)
40
+ - Hugging Face Hub API Key
41
+
42
+ ### Steps
43
+
44
+ 1. Clone the repository:
45
+ ```bash
46
+ git clone https://github.com/yourusername/fear-of-a-black-hat.git
47
+ ```
48
+
49
+ 2. Install dependencies:
50
+ ```bash
51
+ pip install gradio==5.12.0 huggingface_hub
52
+ ```
53
+
54
+ 3. Set up your Hugging Face Hub API key. You can obtain it from [Hugging Face](https://huggingface.co/settings/tokens). Add it to your environment:
55
+ ```bash
56
+ export HF_HOME=<path_to_huggingface_cache>
57
+ export HUGGINGFACE_API_KEY=<your_huggingface_api_key>
58
+ ```
59
+
60
+ 4. Run the app:
61
+ ```bash
62
+ python app.py
63
+ ```
64
+
65
+ 5. Open your browser and go to `http://localhost:7860` to start chatting with the AI!
66
+
67
+ ## Usage
68
+
69
+ Once the app is running, you can interact with the chatbot by typing your message in the input field. The chatbot will generate a response based on the latest NLP model available on Hugging Face. You can ask questions, seek advice, or just have a friendly conversation.
70
+
71
+ ## Deployment
72
+
73
+ To deploy this app on Hugging Face Spaces:
74
+
75
+ 1. Push the code to a new repository on Hugging Face.
76
+ 2. Set the `app.py` as the main entry point for the app.
77
+ 3. Customize the settings and environment variables as needed.
78
+ 4. Launch the app directly on Hugging Face Spaces.
79
+
80
+ For more details on deploying Gradio apps, check out the [Gradio documentation](https://gradio.app/docs).
81
+
82
+ ## Contributing
83
+
84
+ If you'd like to contribute to this project, feel free to fork the repository and submit a pull request. Whether it's improving the chatbot's conversational abilities, enhancing the UI, or fixing bugs, contributions are always welcome!
85
+
86
+ ## License
87
+
88
+ This project is licensed under the MIT License. See the LICENSE file for more details.
89
+
90
+ ## Acknowledgements
91
+
92
+ - **Gradio** for providing an easy-to-use UI framework.
93
+ - **Hugging Face** for offering powerful NLP models and the Inference API.
94
+
95
+ ## Contact
96
+
97
+ For any questions or suggestions, feel free to reach out to us via the GitHub issues or [email](mailto:[email protected]).