Hailay commited on
Commit
c561505
·
verified ·
1 Parent(s): ae8c503

docs: add model card (binary metadata, usage, license)

Browse files
Files changed (1) hide show
  1. README.md +97 -3
README.md CHANGED
@@ -1,3 +1,97 @@
1
- ---
2
- license: apache-2.0
3
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ language:
4
+ - ti
5
+ library_name: fasttext
6
+ tags:
7
+ - fasttext
8
+ - word-embeddings
9
+ - tigrinya
10
+ - low-resource
11
+ ---
12
+
13
+ # FastText Word Embeddings for Tigrinya
14
+
15
+ Subword-aware word embeddings for Tigrinya (Ge'ez script), trained with
16
+ FastText. The model provides vector representations for Tigrinya word forms,
17
+ including out-of-vocabulary words via character n-gram composition.
18
+
19
+ Tigrinya is a morphologically rich, low-resource language for which few
20
+ pretrained embedding resources exist. Subword-aware embeddings are
21
+ particularly suited to such languages, since inflected forms unseen during
22
+ training can still be represented from their character n-grams.
23
+
24
+ ## Technical details
25
+
26
+ Metadata extracted from the released FastText binary.
27
+
28
+ | Property | Value |
29
+ |---|---|
30
+ | Architecture | FastText, skip-gram |
31
+ | Embedding dimension | 300 |
32
+ | Vocabulary size | 156,687 |
33
+ | Character n-gram range | 2–5 |
34
+ | Context window | 5 |
35
+ | Training epochs | 10 |
36
+ | Minimum word count | 5 |
37
+ | Negative samples | 5 |
38
+ | Loss | negative sampling |
39
+ | Bucket size | 2,000,000 |
40
+ | Word n-grams | 1 |
41
+
42
+ > **Training is not reproducible from this repository.** The corpus and
43
+ > preprocessing pipeline are unknown, so the values above describe the
44
+ > released artifact but do not permit retraining it.
45
+
46
+ ## Dataset
47
+
48
+ **Not documented.** The training corpus, its size, sources, and any
49
+ preprocessing or normalisation applied are not recorded in this repository.
50
+
51
+ ## Preprocessing pipeline
52
+
53
+ **Not documented.**
54
+
55
+ ## Usage
56
+
57
+ ```python
58
+ import fasttext
59
+ from huggingface_hub import hf_hub_download
60
+
61
+ path = hf_hub_download("Hailay/fasttext-tigrinya", "fasttext_tigrinya.bin")
62
+ model = fasttext.load_model(path)
63
+
64
+ vector = model.get_word_vector("ኣብ") # 300-dimensional
65
+ neighbours = model.get_nearest_neighbors("ኣብ")
66
+ ```
67
+
68
+ ## Installation
69
+
70
+ ```bash
71
+ pip install fasttext huggingface_hub
72
+ ```
73
+
74
+ ## Evaluation
75
+
76
+ **Not documented.** No evaluation methodology and no benchmark results are
77
+ recorded for this model.
78
+
79
+ ## Intended use
80
+
81
+ Word and subword representations for Tigrinya NLP, including embedding
82
+ initialisation for downstream models. Suitability for any specific
83
+ application has not been evaluated.
84
+
85
+ ## Files
86
+
87
+ | File | Description |
88
+ |---|---|
89
+ | `fasttext_tigrinya.bin` | FastText model binary |
90
+
91
+ ## Citation
92
+
93
+ **Not documented.** No associated publication is recorded for this artifact.
94
+
95
+ ## License
96
+
97
+ Apache 2.0