github-actions
commited on
Commit
·
28a2389
1
Parent(s):
79b8fc8
Update README for HF
Browse files
README.md
CHANGED
|
@@ -1,45 +1,11 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
# 🀄 Chinese Idiom Finder
|
| 4 |
-
|
| 5 |
-
A Large Language Model (LLM)-powered interactive app for exploring and learning **Chinese idioms (成语, 俗语, 谚语)**.
|
| 6 |
-
When a user provides a situation in English, the app suggests a relevant idiom, provides **pinyin**, a **literal English translation**, and a **concise explanation**.
|
| 7 |
-
|
| 8 |
---
|
| 9 |
-
|
| 10 |
-
|
| 11 |
-
|
| 12 |
-
|
| 13 |
-
|
| 14 |
-
|
| 15 |
-
|
| 16 |
-
|
| 17 |
---
|
| 18 |
|
| 19 |
-
## 🚀 How It Works
|
| 20 |
-
1. User inputs a situation (e.g. *“When teamwork is important to succeed”*).
|
| 21 |
-
2. The LLM generates an idiom suggestion.
|
| 22 |
-
3. The idiom is verified against datasets/dictionaries before it's returned.
|
| 23 |
-
|
| 24 |
-

|
| 25 |
-
|
| 26 |
-
---
|
| 27 |
-
|
| 28 |
-
## 🛠️ Tech Stack
|
| 29 |
-
- [Gradio](https://www.gradio.app/) (frontend)
|
| 30 |
-
- Hugging Face Spaces (deployment)
|
| 31 |
-
- Cerebras LLM API
|
| 32 |
-
- Python (requests, pypinyin, etc.)
|
| 33 |
-
|
| 34 |
-
---
|
| 35 |
-
|
| 36 |
-
## 🖥️ Local Development
|
| 37 |
-
|
| 38 |
-
Clone the repo and run locally:
|
| 39 |
-
|
| 40 |
-
```bash
|
| 41 |
-
git clone https://huggingface.co/spaces/chinese-enthusiasts/idiom-finder
|
| 42 |
-
cd idiom-finder
|
| 43 |
-
pip install -r requirements.txt
|
| 44 |
-
python app.py
|
| 45 |
-
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
title: Chinese Idiom Finder
|
| 3 |
+
emoji: 💬
|
| 4 |
+
colorFrom: yellow
|
| 5 |
+
colorTo: purple
|
| 6 |
+
sdk: gradio
|
| 7 |
+
sdk_version: 5.42.0
|
| 8 |
+
app_file: src/app.py
|
| 9 |
+
pinned: false
|
| 10 |
---
|
| 11 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|