cagrigungor commited on
Commit
983c27f
·
verified ·
1 Parent(s): 2b59fe9

Add bilingual 0.3B model card

Browse files
Files changed (1) hide show
  1. README.md +86 -164
README.md CHANGED
@@ -1,199 +1,121 @@
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
+ tags:
4
+ - food
5
+ - menu-understanding
6
+ - allergen-detection
7
+ - text-classification
8
+ language:
9
+ - en
10
+ - tr
11
+ - bn
12
+ - ca
13
+ - hr
14
+ - cs
15
+ - da
16
+ - nl
17
+ - fi
18
+ - fr
19
+ - de
20
+ - el
21
+ - gu
22
+ - he
23
+ - hi
24
+ - hu
25
+ - id
26
+ - it
27
+ - ja
28
+ - kn
29
+ - ko
30
+ - ms
31
+ - ml
32
+ - mr
33
+ - nb
34
+ - or
35
+ - pl
36
+ - pt
37
+ - pa
38
+ - ro
39
+ - ru
40
+ - sk
41
+ - sl
42
+ - es
43
+ - sv
44
+ - ta
45
+ - te
46
+ - th
47
+ - uk
48
+ - ur
49
+ - vi
50
+ - zh
51
  ---
52
 
53
+ # 14-Allergens 0.3B
54
 
55
+ ## English
56
 
57
+ ### Overview
58
 
59
+ 14-Allergens is a multilingual food and menu understanding model for identifying allergen information in short menu descriptions. It is designed to support restaurant software, menu normalization, recipe search, and food-data prototyping.
60
 
61
+ The associated training data contains menu and food text paired with labels from a 14-allergen vocabulary. The current data release contains 131,825 JSONL records and is available at [adisyonist/14-allergens](https://huggingface.co/datasets/adisyonist/14-allergens).
62
 
63
+ Model repository: [adisyonist/14-allergens-0.3b](https://huggingface.co/adisyonist/14-allergens-0.3b)
64
 
65
+ ### Allergen vocabulary
66
 
67
+ The labels are: `celery`, `crustaceans`, `eggs`, `fish`, `gluten`, `lupin`, `milk`, `mollusks`, `mustard`, `nuts`, `peanuts`, `sesame`, `soy`, and `sulfites`.
68
 
69
+ ### Intended use
 
 
 
 
 
 
70
 
71
+ - Extracting or classifying likely allergens from menu text
72
+ - Assisting menu translation, normalization, and search
73
+ - Prototyping food-safety and restaurant-service applications
74
+ - Providing candidate labels for human review
75
 
76
+ ### Limitations and safety
77
 
78
+ The model and data may contain errors, omissions, translation artifacts, and recipe-specific differences. Predictions are not medical advice and must not be used as the sole basis for allergy, food-safety, restaurant-service, or health decisions. Ingredients, preparation methods, and cross-contact information must be verified by qualified professionals before real-world use. No benchmark results are claimed in this model card.
 
 
79
 
80
+ ### Training and evaluation
81
 
82
+ The exact base architecture, hyperparameters, compute resources, and evaluation metrics depend on the training run used to publish this model and are not specified here. Users should evaluate the model on representative, independently reviewed data before deployment.
83
 
84
+ ### License and attribution
85
 
86
+ Review the repository files and the dataset card for the applicable license and source details before redistribution or commercial use.
87
 
88
+ ## Türkçe
89
 
90
+ ### Genel bakış
91
 
92
+ 14-Allergens, kısa menü açıklamalarındaki alerjen bilgilerini belirlemeye yardımcı olmak için hazırlanmış çok dilli bir yiyecek ve menü anlama modelidir. Restoran yazılımları, menü normalizasyonu, tarif arama ve gıda verisi prototipleme çalışmalarında kullanılmak üzere tasarlanmıştır.
93
 
94
+ İlişkili eğitim verileri, yiyecek ve menü metinlerini 14 alerjenlik bir etiket sözlüğüyle eşleştirir. Mevcut veri sürümü 131.825 JSONL kaydı içerir ve [adisyonist/14-allergens](https://huggingface.co/datasets/adisyonist/14-allergens) adresinde bulunur.
95
 
96
+ Model deposu: [adisyonist/14-allergens-0.3b](https://huggingface.co/adisyonist/14-allergens-0.3b)
97
 
98
+ ### Alerjen sözlüğü
99
 
100
+ Etiketler şunlardır: `celery` (kereviz), `crustaceans` (kabuklular), `eggs` (yumurta), `fish` (balık), `gluten` (gluten), `lupin` (acı bakla), `milk` (süt), `mollusks` (yumuşçaklar), `mustard` (hardal), `nuts` (sert kabuklu yemişler), `peanuts` (yer fıstığı), `sesame` (susam), `soy` (soya) ve `sulfites` (sülfitler).
101
 
102
+ ### Kullanım amaçları
103
 
104
+ - Menü metninden olası alerjenleri çıkarmak veya sınıflandırmak
105
+ - Menü çevirisi, normalizasyonu ve aramasına yardımcı olmak
106
+ - Gıda güvenliği ve restoran hizmeti uygulamalarını prototiplemek
107
+ - İnsan denetimine sunulacak aday etiketler üretmek
108
 
109
+ ### Sınırlamalar ve güvenlik
110
 
111
+ Model ve veriler hata, eksik bilgi, çeviri kaynaklı bozulma ve tarife göre değişen içerikler barındırabilir. Tahminler tıbbi tavsiye değildir; alerji, gıda güvenliği, restoran servisi veya sağlık kararlarında tek başına kullanılmamalıdır. Gerçek kullanım öncesinde içerikler, hazırlama yöntemleri ve çapraz bulaşma bilgileri yetkin kişilerce doğrulanmalıdır. Bu model kartında herhangi bir başarı metriği iddia edilmemektedir.
112
 
113
+ ### Eğitim ve değerlendirme
114
 
115
+ Modelin yayınlandığı eğitim çalışmasına ait temel mimari, hiperparametreler, hesaplama kaynakları ve değerlendirme metrikleri burada belirtilmemiştir. Kullanıcılar dağıtımdan önce modeli temsil edici ve bağımsız olarak incelenmiş veriler üzerinde değerlendirmelidir.
116
 
117
+ ### Lisans ve atıf
118
 
119
+ Yeniden dağıtım veya ticari kullanım öncesinde geçerli lisans ve kaynak bilgileri için depo dosyalarını ve veri seti kartını inceleyin.
120
 
121
+ Hasan Çağrı Güngör