Text2Text Generation
Transformers
PyTorch
English
Kinyarwanda
m2m_100
Inference Endpoints
Kleber commited on
Commit
741cfde
1 Parent(s): af01bd9

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +68 -0
README.md ADDED
@@ -0,0 +1,68 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: cc-by-2.0
3
+ datasets:
4
+ - mbazaNLP/NMT_Tourism_parallel_data_en_kin
5
+ - mbazaNLP/NMT_Education_parallel_data_en_kin
6
+ - mbazaNLP/Kinyarwanda_English_parallel_dataset
7
+ language:
8
+ - en
9
+ - rw
10
+ library_name: transformers
11
+ ---
12
+ ## Model Details
13
+
14
+ ### Model Description
15
+
16
+ <!-- Provide a longer summary of what this model is. -->
17
+
18
+ This is a Machine Translation model, finetuned from [NLLB](https://huggingface.co/facebook/nllb-200-distilled-1.3B)-200's distilled 1.3B model, it is meant to be used in machine translation for education-related data.
19
+
20
+
21
+
22
+ - **Finetuning code repository:** the code used to finetune this model can be found [here](https://github.com/Digital-Umuganda/twb_nllb_finetuning)
23
+
24
+
25
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
26
+
27
+
28
+ ## How to Get Started with the Model
29
+
30
+ Use the code below to get started with the model.
31
+
32
+
33
+ ### Training Procedure
34
+
35
+ The model was finetuned on three datasets; a [general](https://huggingface.co/datasets/mbazaNLP/Kinyarwanda_English_parallel_dataset) purpose dataset, a [tourism](https://huggingface.co/datasets/mbazaNLP/NMT_Tourism_parallel_data_en_kin), and an [education](https://huggingface.co/datasets/mbazaNLP/NMT_Education_parallel_data_en_kin) dataset.
36
+
37
+ The model was finetuned in two phases.
38
+
39
+ #### Phase one:
40
+ - General purpose dataset
41
+ - Education dataset
42
+ - Tourism dataset
43
+
44
+ #### Phase two:
45
+ - Tourism dataset
46
+
47
+ Other than the dataset changes between phase one, and phase two finetuning; no other hyperparameters were modified. In both cases, the model was trained on an A100 40GB GPU for two epochs.
48
+
49
+
50
+ ## Evaluation
51
+
52
+ <!-- This section describes the evaluation protocols and provides the results. -->
53
+
54
+
55
+ #### Testing Data
56
+
57
+ <!-- This should link to a Data Card if possible. -->
58
+
59
+
60
+ #### Metrics
61
+
62
+ Model performance was measured using BLEU, spBLEU, and chrF++ metrics.
63
+
64
+ ### Results
65
+
66
+ <!-- [More Information Needed] -->
67
+
68
+