UnarineLeo commited on
Commit
369786e
Β·
verified Β·
1 Parent(s): 5e18b2f

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +49 -4
README.md CHANGED
@@ -1,12 +1,57 @@
1
  ---
2
- title: Lexicon Translator
3
- emoji: πŸ‘€
4
  colorFrom: blue
5
  colorTo: green
6
  sdk: gradio
7
- sdk_version: 5.35.0
8
  app_file: app.py
9
  pinned: false
 
10
  ---
11
 
12
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: English to Venda Translator
3
+ emoji: 🌍
4
  colorFrom: blue
5
  colorTo: green
6
  sdk: gradio
7
+ sdk_version: 4.0.0
8
  app_file: app.py
9
  pinned: false
10
+ license: apache-2.0
11
  ---
12
 
13
+ # English to Venda Translator 🌍
14
+
15
+ A Gradio-based web application for translating English text to Venda (Tshivenda) using a fine-tuned NLLB model.
16
+
17
+ ## Features
18
+
19
+ - **Single Translation**: Translate individual sentences or paragraphs
20
+ - **Batch Translation**: Translate multiple sentences at once
21
+ - **Adjustable Parameters**: Control translation quality and speed
22
+ - **Example Sentences**: Try pre-loaded examples
23
+ - **User-friendly Interface**: Clean, intuitive design
24
+
25
+ ## Model
26
+
27
+ This app uses the `UnarineLeo/nllb_eng_ven_terms` model, which is based on the NLLB (No Language Left Behind) architecture and fine-tuned specifically for English to Venda translation.
28
+
29
+ ## About Venda (Tshivenda)
30
+
31
+ Venda is a Bantu language spoken by approximately 1.2 million people, primarily in South Africa and Zimbabwe. It is one of the 11 official languages of South Africa.
32
+
33
+ ## Usage
34
+
35
+ 1. **Single Translation**: Enter English text in the input box and click "Translate"
36
+ 2. **Batch Translation**: Enter multiple sentences (one per line) for bulk translation
37
+ 3. **Parameters**: Adjust max length and beam search parameters for quality vs speed trade-offs
38
+
39
+ ## Technical Details
40
+
41
+ - **Model**: UnarineLeo/nllb_eng_ven_terms
42
+ - **Framework**: Transformers, PyTorch
43
+ - **Interface**: Gradio
44
+ - **Language Codes**: eng_Latn β†’ ven_Latn
45
+
46
+ ## Installation
47
+
48
+ To run locally:
49
+
50
+ ```bash
51
+ pip install -r requirements.txt
52
+ python app.py
53
+ ```
54
+
55
+ ## License
56
+
57
+ Apache 2.0