Mel Seto
commited on
Commit
·
0e6e13c
1
Parent(s):
1b7aa02
update readme with better description and screenshot
Browse files
README.md
CHANGED
|
@@ -2,13 +2,13 @@
|
|
| 2 |
|
| 3 |
# 🀄 Chinese Idiom Finder
|
| 4 |
|
| 5 |
-
|
| 6 |
-
|
| 7 |
|
| 8 |
---
|
| 9 |
|
| 10 |
## ✨ Features
|
| 11 |
-
- 🔍 **Idiom search**
|
| 12 |
- ✅ **Idiom verification** using:
|
| 13 |
- [ChID dataset](https://arxiv.org/abs/1906.01265) (Chinese Idiom Dataset)
|
| 14 |
- CC-CEDICT (open Chinese–English dictionary)
|
|
@@ -17,21 +17,18 @@ Given a situation, the app suggests a relevant idiom, provides **pinyin**, a **l
|
|
| 17 |
---
|
| 18 |
|
| 19 |
## 🚀 How It Works
|
| 20 |
-
1. User inputs a situation (e.g. *“When
|
| 21 |
2. The LLM generates an idiom suggestion.
|
| 22 |
-
3. The idiom is verified against datasets/dictionaries.
|
| 23 |
-
|
| 24 |
-
|
| 25 |
-
- Pinyin
|
| 26 |
-
- Literal translation
|
| 27 |
-
- Concise explanation
|
| 28 |
|
| 29 |
---
|
| 30 |
|
| 31 |
## 🛠️ Tech Stack
|
| 32 |
- [Gradio](https://www.gradio.app/) (frontend)
|
| 33 |
- Hugging Face Spaces (deployment)
|
| 34 |
-
-
|
| 35 |
- Python (requests, pypinyin, etc.)
|
| 36 |
|
| 37 |
---
|
|
@@ -47,7 +44,7 @@ pip install -r requirements.txt
|
|
| 47 |
python app.py
|
| 48 |
|
| 49 |
|
| 50 |
-
|
| 51 |
---
|
| 52 |
|
| 53 |
title: Chinese Idiom Finder
|
|
|
|
| 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 |
## ✨ Features
|
| 11 |
+
- 🔍 **Idiom search** powered by an LLM (**gpt-oss-120b**) running on Cerebras’s AI inference platform. This model was chosen for its strong performance and availability on the Cerebras Free tier.
|
| 12 |
- ✅ **Idiom verification** using:
|
| 13 |
- [ChID dataset](https://arxiv.org/abs/1906.01265) (Chinese Idiom Dataset)
|
| 14 |
- CC-CEDICT (open Chinese–English dictionary)
|
|
|
|
| 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 |
---
|
|
|
|
| 44 |
python app.py
|
| 45 |
|
| 46 |
|
| 47 |
+
## 🤗 HuggingFace setup (required for app to run)
|
| 48 |
---
|
| 49 |
|
| 50 |
title: Chinese Idiom Finder
|