RabbitRedux / README.md
Canstralian's picture
Update README.md
4894707 verified
---
title: RabbitRedux
emoji:
colorFrom: pink
colorTo: purple
sdk: gradio
sdk_version: 5.12.0
app_file: app.py
pinned: false
license: mit
---
# RabbitRedux
RabbitRedux is an example chatbot application demonstrating the integration of [Gradio](https://gradio.app) with the [`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). It allows users to interact with a language model for dynamic conversation capabilities.
## Features
- 💬 User-friendly Gradio interface.
- 🌐 Powered by Hugging Face's Inference API for seamless model interaction.
- 🎨 Customizable inputs including system message, temperature, max tokens, and top-p.
- 🚀 Easy to run locally or deploy on Hugging Face Spaces.
## Usage
1. Adjust the input sliders to customize the chatbot's behavior.
2. Enter a message to initiate a conversation.
3. Receive responses in real-time with streaming capabilities.
## Run Locally
To run RabbitRedux locally:
1. Clone the repository.
2. Install the required dependencies:
```bash
pip install -r requirements.txt
```
3. Start the app:
```bash
python app.py
```
4. Access the app at `http://localhost:7860`.
## License
RabbitRedux is licensed under the [Apache-2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
```
You can add this to your Space README or include the description in the relevant sections. Let me know if you'd like any other customizations!