HeyDunaX commited on
Commit
a74d8ef
Β·
verified Β·
1 Parent(s): 7be519d

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +69 -196
README.md CHANGED
@@ -1,199 +1,72 @@
1
  ---
2
- library_name: transformers
3
- tags: []
 
 
 
 
 
 
 
 
 
 
 
4
  ---
5
 
6
- # Model Card for Model ID
7
-
8
- <!-- Provide a quick summary of what the model is/does. -->
9
-
10
-
11
-
12
- ## Model Details
13
-
14
- ### Model Description
15
-
16
- <!-- Provide a longer summary of what this model is. -->
17
-
18
- This is the model card of a πŸ€— transformers model that has been pushed on the Hub. This model card has been automatically generated.
19
-
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
-
28
- ### Model Sources [optional]
29
-
30
- <!-- Provide the basic links for the model. -->
31
-
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
35
-
36
- ## Uses
37
-
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
39
-
40
- ### Direct Use
41
-
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
-
44
- [More Information Needed]
45
-
46
- ### Downstream Use [optional]
47
-
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
-
50
- [More Information Needed]
51
-
52
- ### Out-of-Scope Use
53
-
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
-
56
- [More Information Needed]
57
-
58
- ## Bias, Risks, and Limitations
59
-
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- [More Information Needed]
63
-
64
- ### Recommendations
65
-
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
-
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
-
70
- ## How to Get Started with the Model
71
-
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
-
76
- ## Training Details
77
-
78
- ### Training Data
79
-
80
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
81
-
82
- [More Information Needed]
83
-
84
- ### Training Procedure
85
-
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
-
88
- #### Preprocessing [optional]
89
-
90
- [More Information Needed]
91
-
92
-
93
- #### Training Hyperparameters
94
-
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- [More Information Needed]
102
-
103
- ## Evaluation
104
-
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
- ### Testing Data, Factors & Metrics
108
-
109
- #### Testing Data
110
-
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- [More Information Needed]
140
-
141
- ## Environmental Impact
142
-
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- [More Information Needed]
158
-
159
- ### Compute Infrastructure
160
-
161
- [More Information Needed]
162
-
163
- #### Hardware
164
-
165
- [More Information Needed]
166
-
167
- #### Software
168
-
169
- [More Information Needed]
170
-
171
- ## Citation [optional]
172
-
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
174
-
175
- **BibTeX:**
176
-
177
- [More Information Needed]
178
-
179
- **APA:**
180
-
181
- [More Information Needed]
182
-
183
- ## Glossary [optional]
184
-
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
186
-
187
- [More Information Needed]
188
-
189
- ## More Information [optional]
190
-
191
- [More Information Needed]
192
-
193
- ## Model Card Authors [optional]
194
-
195
- [More Information Needed]
196
-
197
- ## Model Card Contact
198
-
199
- [More Information Needed]
 
1
  ---
2
+ language: tr
3
+ license: apache-2.0
4
+ tags:
5
+ - tokenizer
6
+ - morphel
7
+ - morphology-aware
8
+ - turkish
9
+ - xnli
10
+ - nlp-research
11
+ - low-resource
12
+ - ablation-random-baseline
13
+ datasets:
14
+ - facebook/xnli
15
  ---
16
 
17
+ # NIRVLab β€” MorpheL Tokenizer for Turkish XNLI β€” ABLATION: Random-segmentation null baseline
18
+
19
+ **This is NOT the real MorpheL algorithm.** Every algorithmic component is
20
+ disabled: no MI scoring (Eq.1-4), no vowel-consonant plausible-boundary
21
+ pre-filter, no TopK candidate ranking (Eq.5), no Gumbel sampling (Eq.6-9).
22
+ Boundary count/position come from a plain uniform RNG. Exists purely as a
23
+ worst-case sanity control for MorpheL's own pipeline (Proposal: *MorpheL:
24
+ Morphology-Aware Tokenizer Adaptation for Pretrained Models in Low-Resource
25
+ Languages*) β€” if the real MI+Gumbel pipeline doesn't clearly beat this, the
26
+ added complexity isn't earning its keep.
27
+
28
+ Trained on the Turkish (`tr`) subset of
29
+ [facebook/xnli](https://huggingface.co/datasets/facebook/xnli) β€” all splits.
30
+
31
+ ## Algorithm (ablated)
32
+
33
+ Words are segmented by drawing a uniform-random number of cuts (0-2) and
34
+ uniform-random cut positions β€” no MI, no vowel filter, no Gumbel, no learned
35
+ signal of any kind. Segmentation is cached at induction time with a fixed
36
+ seed for reproducibility, but carries no linguistic information.
37
+
38
+ ## Training Config
39
+
40
+ | Parameter | Value |
41
+ |---|---|
42
+ | Algorithm | RANDOM (ablation β€” MI+Gumbel+vowel-filter all OFF) |
43
+ | Vocabulary size | 32,055 |
44
+ | random_max_cuts | 2 |
45
+ | seed | 42 |
46
+ | min_frequency | 2 |
47
+ | Special tokens | `<s>, <pad>, </s>, <unk>, <mask>` |
48
+ | Corpus | `facebook/xnli/tr` β€” all splits (800,404 sentences) |
49
+ | Vowel set | N/A β€” no plausible-boundary filter in this ablation |
50
+
51
+ ## Evaluation Metrics (vs Baselines, vocab_size=32000, same corpus)
52
+
53
+ | Metric | BPE | WordPiece | Unigram | MorpheL (full) | **Random (this ablation)** |
54
+ |---|---|---|---|---|
55
+ | Fertility ↓ | β€” | β€” | β€” | β€” | **1.4317** |
56
+ | Tokens/char ↓ | β€” | β€” | β€” | β€” | **0.1911** |
57
+ | Avg seq len ↓ | β€” | β€” | β€” | β€” | **16.92** |
58
+ | Vocab coverage ↑ | β€” | β€” | β€” | β€” | **1.0000** |
59
+ | OOV rate ↓ | β€” | β€” | β€” | β€” | **0.0000** |
60
+
61
+ *Fill baseline columns after running baseline notebooks.*
62
+
63
+ ## Usage
64
+
65
+ ```python
66
+ from transformers import AutoTokenizer
67
+ tokenizer = AutoTokenizer.from_pretrained("NIRVLab/xnli-morphel-tr-32k-ablation-random-baseline")
68
+ ```
69
+
70
+ > **Note**: this checkpoint uses RANDOM segmentation (ablation control) β€” do
71
+ > not use it for actual MorpheL comparisons other than as the worst-case
72
+ > sanity baseline. No temperature / Gumbel parameter applies here.