rrrr66254 commited on
Commit
4e1dcb1
·
verified ·
1 Parent(s): 87e1640

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +77 -131
README.md CHANGED
@@ -1,199 +1,145 @@
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
  library_name: transformers
3
+ language:
4
+ - en
5
+ metrics:
6
+ - bertscore
7
+ base_model:
8
+ - facebook/bart-base
9
  ---
10
 
11
  # Model Card for Model ID
12
 
13
+ This model is a fine-tuned version of `facebook/bart-base`, trained to convert American Sign Language (ASL) gloss sequences into fluent English sentences. It is designed to assist in research, education, and accessibility applications involving gloss-based ASL interpretation.
14
+ The model was trained using high-quality aligned pairs of gloss annotations and English translations, and evaluated using BERTScore.
 
15
 
16
  ## Model Details
17
 
18
  ### Model Description
19
 
 
 
20
  This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
21
 
22
+ - **Developed by:** Dongjun Kim
23
+ - **Model type:** Text2Text Generation
24
+ - **Language(s) (NLP):** English
 
 
25
  - **License:** [More Information Needed]
26
  - **Finetuned from model [optional]:** [More Information Needed]
27
 
 
 
 
28
 
29
+ ## Intended Uses
 
 
30
 
31
+ This model is fine-tuned for translating American Sign Language (ASL) gloss input sequences into natural, grammatically correct English sentences. It can be used for:
32
 
33
+ - Building real-time sign language interpretation systems
34
+ - Research in sign language understanding and low-resource language translation
35
+ - Educational tools for ASL learners to see gloss-to-English transformation
36
+ - Data augmentation for multimodal ASL translation tasks
37
 
38
+ ## Out-of-Scope Uses
39
 
40
+ The model is **not** suitable for:
41
 
42
+ - Translating from ASL videos or images directly (no visual input is processed)
43
+ - Formal legal or medical translation without human validation
44
+ - General-purpose translation outside ASL gloss context
45
+ - Languages other than English
46
 
47
+ ## How to Use
48
 
49
+ ```python
50
+ from transformers import AutoTokenizer, AutoModelForSeq2SeqLM
51
 
52
+ tokenizer = AutoTokenizer.from_pretrained("your-username/bart-gloss-finetuned")
53
+ model = AutoModelForSeq2SeqLM.from_pretrained("your-username/bart-gloss-finetuned")
54
 
55
+ gloss_input = "YOU GO STORE TOMORROW?"
56
+ inputs = tokenizer(gloss_input, return_tensors="pt")
57
+ output = model.generate(**inputs)
58
+ print(tokenizer.decode(output[0], skip_special_tokens=True))
 
59
 
60
  ## Bias, Risks, and Limitations
61
 
62
+ This model is trained on American Sign Language (ASL) glosses mapped to natural English sentences. As such, it may inherit several limitations:
63
 
64
+ - **Data bias**: If the training data overrepresents certain sentence structures, cultural expressions, or gloss forms, the model may produce outputs that lack variety or inclusivity.
65
+ - **Limited linguistic scope**: The model only understands **ASL gloss** as input and **English** as output. It does not cover other sign languages or spoken/written languages.
66
+ - **Context loss**: ASL gloss does not encode facial expressions, spatial grammar, or non-manual signals, which are essential in ASL. The model may misrepresent meaning as a result.
67
+ - **Generalization risk**: The model may not generalize well to gloss styles or sentence structures it wasn’t trained on.
68
 
69
+ Outputs should not be used in **critical settings** (e.g., legal, medical, or emergency interpreting) without human review.
70
 
71
+ ### Recommendations
 
 
 
 
 
 
72
 
73
+ - Human-in-the-loop: Always have a fluent signer or linguist verify model outputs in any production or educational setting.
74
+ - Data expansion: Consider fine-tuning with more diverse gloss datasets that include different dialects or informal structures.
75
+ - Downstream use: If used as part of a larger translation or accessibility pipeline, include disclaimers about potential misinterpretation due to a lack of non-manual signals.
76
 
77
  ## Training Details
78
 
79
  ### Training Data
80
 
81
+ The model was fine-tuned on a custom dataset of 1:1 pairs of ASL gloss and fluent English sentences.
82
+ The glosses are structured representations of ASL without punctuation, articles, or verb conjugation. Each gloss sentence is paired with a corresponding English sentence that captures its intended meaning.
83
+ The dataset was cleaned to remove non-English outputs, duplicates, and ill-formed pairs using custom filters.
84
 
85
  ### Training Procedure
86
 
87
+ The training used the Hugging Face `Trainer` API with a sequence-to-sequence objective.
88
+ The training leveraged a BART-based architecture (facebook/bart-base) to learn a mapping from gloss to fluent English sentences.
89
 
90
  #### Preprocessing [optional]
91
 
92
+ - Input text was trimmed and normalized
93
+ - Tokenizer: Pretrained BART tokenizer
94
+ - Special tokens: `[INST]` and `[/INST]` were used to delimit gloss input and output reference
95
 
 
 
 
 
 
 
 
 
 
 
 
 
 
96
 
 
97
 
98
+ #### Training Hyperparameters
99
 
100
+ #### Training Hyperparameters
101
 
102
+ - **Base model**: `facebook/bart-base`
103
+ - **Epochs**: 3
104
+ - **Learning rate**: 5e-5
105
+ - **Batch size**: 4 per device (both train and eval)
106
+ - **Gradient accumulation**: Not used
107
+ - **Weight decay**: 0.01
108
+ - **Learning rate scheduler**: Linear (default in Trainer)
109
+ - **Precision**: Mixed precision (fp16=True)
110
+ - **Evaluation strategy**: Per epoch
111
+ - **Save strategy**: Per epoch (with `save_total_limit=2`)
112
+ - **Logging frequency**: Every 50 steps
113
+ - **Early stopping**: Custom callback based on BERTScore with patience = 2
114
+ - **Evaluation metric**: BERTScore (F1), computed with `microsoft/deberta-xlarge-mnli`
115
 
116
  #### Factors
117
 
118
+ This model does not explicitly disaggregate results by demographic group, signer identity, or domain. However, the training data may implicitly reflect distributional biases present in publicly available gloss datasets.
119
 
 
120
 
121
  #### Metrics
122
 
123
+ - **Primary metric**: BERTScore (F1)
124
+ - **Model selection**: Best checkpoint based on highest validation BERTScore-F1
125
+ - BERTScore is preferred for this task due to its alignment with semantic quality over token-level exactness (e.g., BLEU or ROUGE)
126
 
127
  ### Results
128
 
129
+ After 2 epochs of training, the model achieved:
 
 
 
130
 
131
+ - **BERTScore-F1**: 0.83 on held-out evaluation set of 500 gloss-reference pairs
132
+ - Qualitative inspection confirms that most outputs are fluent and contextually aligned, though some suffer from missing function words or incorrect verb tenses.
133
 
 
134
 
135
+ #### Summary
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
136
 
137
+ This model demonstrates strong potential for gloss-to-English translation, with near-human fluency in many cases. However, further work is needed to improve generalization to informal gloss styles and integrate non-manual features.
138
 
139
+ ## Model Card Authors
140
 
141
+ - Dongjun Kim
142
 
143
  ## Model Card Contact
144
 
145
+ - rrrr66254@gmail.com