sinatayebati commited on
Commit
5c9d14d
โ€ข
1 Parent(s): 62009ed

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +9 -115
README.md CHANGED
@@ -1,116 +1,10 @@
1
- # TALKING DUCK ๐Ÿฆ†
2
-
3
- Welcome to the coolest corner of the coding pond - <a href="https://huggingface.co/spaces/sinatayebati/Talking-Duck">**TALKING DUCK**!</a> This isn't just any duck. It's your feathered friend that quacks code solutions and dives deep into programming puzzles. Ever wished for a coding buddy that could talk back, understand your code woes, and not just stare blankly at you? **TALKING DUCK** is here to change the game!
4
-
5
- Dive in beak-first and see TALKING DUCK in action over at its very own <a href="https://huggingface.co/spaces/sinatayebati/Talking-Duck">Hugging Face Space</a>. It's like a pond party for coders, and you're invited! ๐ŸŽ‰
6
-
7
-
8
- ## What's the Quack?
9
-
10
- **TALKING DUCK** is an LLM-powered chatbot that does more than just float around. It listens (literally) to your code problems, thanks to its audio-to-text superpower, and then it gets its webbed feet dirty by diving into the depths of code logic to bring you pearls of wisdom... or at least, the answers to your coding questions.
11
-
12
- Whether you're tangled in the vines of Python, lost in the braces of JavaScript, or just need someone to tell you "It's gonna be okay, buddy," **TALKING DUCK** is your go-to aquatic ally.
13
-
14
- ## Features
15
-
16
- - ๐ŸŽค **Audio Input**: Just quack your question into your mic.
17
- - ๐Ÿค” **Smart Analysis**: Leveraging the brainy might of LLM models, including the one and only `mistralai/Mistral-7B-v0.1`.
18
- - ๐Ÿ’ก **Insightful Answers**: Get recommendations, solutions, and sometimes just a friendly quack.
19
- - ๐Ÿฆ† **Fun Interface**: Because who said coding assistants need to be boring?
20
-
21
-
22
- # Get Started
23
- To build Talking Duck, you could build from docker or setup a conda environment.
24
-
25
-
26
- ## Docker Setup
27
-
28
- If you prefer to keep your machine clean and run everything in containers, **TALKING DUCK** is Docker-ready! Just follow these simple steps to containerize the quack:
29
-
30
- ### Build the Docker Image
31
-
32
- Navigate to the root directory of the cloned project where the `Dockerfile` is located, and run:
33
-
34
- ```bash
35
- docker build -t talking-duck .
36
- ```
37
-
38
- This command builds a Docker image named `talking-duck` based on the instructions in your `Dockerfile`.
39
-
40
- ### Run the Container
41
-
42
- Once the build is complete, you can run **TALKING DUCK** in a Docker container using:
43
-
44
- ```bash
45
- docker run -p 7860:7860 talking-duck
46
- ```
47
-
48
- This command starts a container from the `talking-duck` image, mapping port 7860 of the container to port 7860 on your host machine.
49
-
50
- ### Visit Your Duck
51
-
52
- Open your favorite web browser and navigate to `http://localhost:7860` to interact with **TALKING DUCK**. No installation mess, just pure, unadulterated duck fun.
53
-
54
- ### Docker Compose (Optional)
55
-
56
- For an even easier setup, if you have a `docker-compose.yml` file at the root of your project, you can start **TALKING DUCK** with just one command:
57
-
58
- ```bash
59
- docker-compose up --build
60
- ```
61
-
62
- This command uses Docker Compose to build the image and run the container as defined in your `docker-compose.yml` file. It's perfect for when you want to get up and running with minimal fuss.
63
-
64
  ---
65
-
66
- **Note:** Be sure to adjust the `docker build` and `docker run` commands based on your specific Docker setup, including the correct image names and any additional options you might need. The instructions above assume a basic setup for demonstration purposes.
67
-
68
- Don't forget to check the Docker and Docker Compose documentation for more detailed information on building and running containers.
69
-
70
- ## Env setup
71
-
72
- Want your very own **TALKING DUCK**? Follow these steps to clone this repository and get quacking:
73
-
74
-
75
- 1. **Clone the Repository**
76
-
77
- ```bash
78
- git clone https://github.com/your-username/talking-duck.git
79
- cd talking-duck
80
- ```
81
-
82
- 2. **Set Up Your Pond**
83
-
84
- Make sure you have Python installed, then dive in with:
85
-
86
- ```bash
87
- pip install -r requirements.txt
88
- ```
89
-
90
- 3. **Wake the Duck**
91
-
92
- Start your **TALKING DUCK** with:
93
-
94
- ```bash
95
- python app.py
96
- ```
97
-
98
- Visit `http://localhost:7860` in your web browser to see **TALKING DUCK** in all its glory!
99
-
100
-
101
- Sure! Hereโ€™s an addition to the README that includes instructions for building and running the **TALKING DUCK** project using Docker. This section assumes that youโ€™ve Dockerized your Gradio app, as discussed earlier.
102
-
103
- ---
104
-
105
-
106
- ## Contribute
107
-
108
- Got ideas to make **TALKING DUCK** even cooler? Fork this repo, make your changes, and submit a pull request. New jokes, features, and improvements are always welcome. Let's make coding fun together!
109
-
110
- ## License
111
-
112
- **TALKING DUCK** is released under the MIT License. See `LICENSE` for more information.
113
-
114
- ---
115
-
116
- Remember to replace `https://github.com/your-username/talking-duck.git` with the actual URL of your repository. Feel free to adjust the tone and content to match your project's personality and features more closely!
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ license: mit
3
+ title: Talking Duck
4
+ sdk: docker
5
+ emoji: ๐Ÿš€
6
+ colorFrom: yellow
7
+ colorTo: indigo
8
+ pinned: false
9
+ short_description: TALKING DUCK is an LLM-powered chatbot for code debugging
10
+ ---