Spaces:
Sleeping
Sleeping
Add README content with instructions and examples
Browse filesIncluded usage guide, supported languages, and placeholder examples for users.
README.md
CHANGED
|
@@ -10,5 +10,56 @@ pinned: false
|
|
| 10 |
license: apache-2.0
|
| 11 |
short_description: Multilingual NER app using Gradio.
|
| 12 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 13 |
|
| 14 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
|
|
|
| 10 |
license: apache-2.0
|
| 11 |
short_description: Multilingual NER app using Gradio.
|
| 12 |
---
|
| 13 |
+
# 🌍 Multilingual Named Entity Recognition (NER) App — Hugging Face Version
|
| 14 |
+
|
| 15 |
+
A robust and multilingual Named Entity Recognition (NER) app powered by **Gradio** and Hugging Face Transformers. It extracts entities such as names, organizations, and locations from user input across multiple languages.
|
| 16 |
+
|
| 17 |
+
## 🧠 About the Model
|
| 18 |
+
- **Pipeline:** `ner`
|
| 19 |
+
- **Model:** `Davlan/xlm-roberta-base-ner-hrl`
|
| 20 |
+
- **Framework:** Hugging Face Transformers
|
| 21 |
+
- **Task:** Named Entity Recognition (NER) in multiple languages
|
| 22 |
+
|
| 23 |
+
## 💡 Features
|
| 24 |
+
- Supports multilingual input (English, Spanish, German, French, etc.)
|
| 25 |
+
- Extracts key entities like names, organizations, and locations
|
| 26 |
+
- Real-time inference with clear visual output
|
| 27 |
+
- Hosted on Hugging Face Spaces
|
| 28 |
+
|
| 29 |
+
## ⚙️ Instructions for Users
|
| 30 |
+
|
| 31 |
+
> This app identifies entities like names, organizations, and places in your sentence.
|
| 32 |
+
>
|
| 33 |
+
> ✅ Works best with supported languages such as **English**, **Spanish**, **French**, **German**, **Dutch**, **Chinese**, **Hindi**, and more.
|
| 34 |
+
>
|
| 35 |
+
> ⚠️ Avoid using overly long or grammatically broken inputs.
|
| 36 |
+
>
|
| 37 |
+
> ❌ Less effective for **Japanese**, and unsupported languages or mixed scripts.
|
| 38 |
+
|
| 39 |
+
### 📌 Example Inputs
|
| 40 |
+
|
| 41 |
+
**English:**
|
| 42 |
+
`Barack Obama was born in Hawaii and served as the 44th president of the United States.`
|
| 43 |
+
|
| 44 |
+
**Spanish:**
|
| 45 |
+
`Lionel Messi nació en Rosario y juega para la selección de Argentina.`
|
| 46 |
+
|
| 47 |
+
**French:**
|
| 48 |
+
`Emmanuel Macron est le président de la République française.`
|
| 49 |
+
|
| 50 |
+
**German:**
|
| 51 |
+
`Angela Merkel war die Bundeskanzlerin von Deutschland.`
|
| 52 |
+
|
| 53 |
+
---
|
| 54 |
+
|
| 55 |
+
## 🚀 How to Run Locally
|
| 56 |
+
Install the required packages:
|
| 57 |
+
```bash
|
| 58 |
+
pip install -r requirements.txt
|
| 59 |
+
```
|
| 60 |
+
Then run the app:
|
| 61 |
+
```bash
|
| 62 |
+
python app.py
|
| 63 |
+
```
|
| 64 |
|
| 65 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|