os-odyssey commited on
Commit
0471e45
·
verified ·
1 Parent(s): 4aac83a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +21 -17
README.md CHANGED
@@ -1,21 +1,25 @@
1
- # odyssey — Coding Assistant & Rewriter (Gradio / Hugging Face Space)
 
 
 
 
 
 
 
 
 
2
 
3
- A simple Gradio app that uses Hugging Face models (for example: Qwen2.5-Coder-32B) via the Hugging Face Inference API.
4
- It provides an "Analyze → Rewrite" mode where the model first reviews the input and then generates an optimized rewrite.
5
 
6
- ## Features
7
- - Analyze input code or prompt (bugs, edge-cases, security, performance).
8
- - Produce an optimized rewritten version ready to run or feed into other models.
9
- - Full user control over model name, max_new_tokens, temperature, top_p, top_k.
10
- - Ready for deployment on Hugging Face Spaces (Gradio).
11
 
12
- ## Files
13
- - `app.py` : main Gradio application
14
- - `requirements.txt` : Python dependencies
15
- - `README.md` : this file
 
16
 
17
- ## Run locally (using Hugging Face Inference API)
18
- 1. Create a Hugging Face API token at https://huggingface.co/settings/tokens
19
- 2. Export token as an environment variable or provide it in the UI:
20
- ```bash
21
- export HF_API_TOKEN="your_token_here"
 
1
+ ---
2
+ title: odyssey-coder
3
+ emoji: 🤖
4
+ colorFrom: gray
5
+ colorTo: green
6
+ sdk: gradio
7
+ sdk_version: "3.50"
8
+ app_file: app.py
9
+ pinned: false
10
+ ---
11
 
12
+ # Odyssey Coder AI Coding Assistant
 
13
 
14
+ This Gradio-based app connects to Hugging Face models (like Qwen2.5-Coder-32B) using your HF_API_TOKEN.
 
 
 
 
15
 
16
+ ## Features
17
+ - Analyze input code or prompt
18
+ - Rewrite and optimize code or prompt
19
+ - Control model settings: max_tokens, temperature, top_p, top_k
20
+ - Public usage with token stored safely in Secrets
21
 
22
+ ## Usage
23
+ 1. Ensure `requirements.txt` is installed
24
+ 2. Set your HF token in Secrets as `HF_API_TOKEN`
25
+ 3. Run `app.py` or use directly on Hugging Face Space