Filippo commited on
Commit
55f7fd9
1 Parent(s): 97fba46

Delete e5-small-v2-onnx_model_card.md

Browse files
Files changed (1) hide show
  1. e5-small-v2-onnx_model_card.md +0 -248
e5-small-v2-onnx_model_card.md DELETED
@@ -1,248 +0,0 @@
1
- ---
2
-
3
- ---
4
-
5
-
6
-
7
-
8
-
9
-
10
- # Model Card for e5-small-v2-onnx
11
-
12
- <!-- Provide a quick summary of what the model is/does. [Optional] -->
13
- Work in progress!
14
-
15
- Learning how to use Optimum with the https://huggingface.co/intfloat/e5-small-v2 model.
16
-
17
-
18
-
19
-
20
- # Table of Contents
21
-
22
- - [Model Card for e5-small-v2-onnx](#model-card-for--model_id-)
23
- - [Table of Contents](#table-of-contents)
24
- - [Table of Contents](#table-of-contents-1)
25
- - [Model Details](#model-details)
26
- - [Model Description](#model-description)
27
- - [Uses](#uses)
28
- - [Direct Use](#direct-use)
29
- - [Downstream Use [Optional]](#downstream-use-optional)
30
- - [Out-of-Scope Use](#out-of-scope-use)
31
- - [Bias, Risks, and Limitations](#bias-risks-and-limitations)
32
- - [Recommendations](#recommendations)
33
- - [Training Details](#training-details)
34
- - [Training Data](#training-data)
35
- - [Training Procedure](#training-procedure)
36
- - [Preprocessing](#preprocessing)
37
- - [Speeds, Sizes, Times](#speeds-sizes-times)
38
- - [Evaluation](#evaluation)
39
- - [Testing Data, Factors & Metrics](#testing-data-factors--metrics)
40
- - [Testing Data](#testing-data)
41
- - [Factors](#factors)
42
- - [Metrics](#metrics)
43
- - [Results](#results)
44
- - [Model Examination](#model-examination)
45
- - [Environmental Impact](#environmental-impact)
46
- - [Technical Specifications [optional]](#technical-specifications-optional)
47
- - [Model Architecture and Objective](#model-architecture-and-objective)
48
- - [Compute Infrastructure](#compute-infrastructure)
49
- - [Hardware](#hardware)
50
- - [Software](#software)
51
- - [Citation](#citation)
52
- - [Glossary [optional]](#glossary-optional)
53
- - [More Information [optional]](#more-information-optional)
54
- - [Model Card Authors [optional]](#model-card-authors-optional)
55
- - [Model Card Contact](#model-card-contact)
56
- - [How to Get Started with the Model](#how-to-get-started-with-the-model)
57
-
58
-
59
- # Model Details
60
-
61
- ## Model Description
62
-
63
- <!-- Provide a longer summary of what this model is/does. -->
64
- Work in progress!
65
-
66
- Learning how to use Optimum with the https://huggingface.co/intfloat/e5-small-v2 model.
67
-
68
- - **Developed by:** More information needed
69
- - **Shared by [Optional]:** More information needed
70
- - **Model type:** Language model
71
- - **Language(s) (NLP):** en
72
- - **License:** mit
73
- - **Parent Model:** More information needed
74
- - **Resources for more information:** More information needed
75
-
76
-
77
-
78
- # Uses
79
-
80
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
81
-
82
- ## Direct Use
83
-
84
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
85
- <!-- If the user enters content, print that. If not, but they enter a task in the list, use that. If neither, say "more info needed." -->
86
-
87
-
88
-
89
-
90
- ## Downstream Use [Optional]
91
-
92
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
93
- <!-- If the user enters content, print that. If not, but they enter a task in the list, use that. If neither, say "more info needed." -->
94
-
95
-
96
-
97
-
98
- ## Out-of-Scope Use
99
-
100
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
101
- <!-- If the user enters content, print that. If not, but they enter a task in the list, use that. If neither, say "more info needed." -->
102
-
103
-
104
-
105
-
106
- # Bias, Risks, and Limitations
107
-
108
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
109
-
110
- Significant research has explored bias and fairness issues with language models (see, e.g., [Sheng et al. (2021)](https://aclanthology.org/2021.acl-long.330.pdf) and [Bender et al. (2021)](https://dl.acm.org/doi/pdf/10.1145/3442188.3445922)). Predictions generated by the model may include disturbing and harmful stereotypes across protected classes; identity characteristics; and sensitive, social, and occupational groups.
111
-
112
-
113
- ## Recommendations
114
-
115
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
116
-
117
-
118
-
119
-
120
-
121
- # Training Details
122
-
123
- ## Training Data
124
-
125
- <!-- This should link to a Data 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. -->
126
-
127
- More information on training data needed
128
-
129
-
130
- ## Training Procedure
131
-
132
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
133
-
134
- ### Preprocessing
135
-
136
- More information needed
137
-
138
- ### Speeds, Sizes, Times
139
-
140
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
141
-
142
- More information needed
143
-
144
- # Evaluation
145
-
146
- <!-- This section describes the evaluation protocols and provides the results. -->
147
-
148
- ## Testing Data, Factors & Metrics
149
-
150
- ### Testing Data
151
-
152
- <!-- This should link to a Data Card if possible. -->
153
-
154
- More information needed
155
-
156
-
157
- ### Factors
158
-
159
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
160
-
161
- More information needed
162
-
163
- ### Metrics
164
-
165
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
166
-
167
- More information needed
168
-
169
- ## Results
170
-
171
- More information needed
172
-
173
- # Model Examination
174
-
175
- More information needed
176
-
177
- # Environmental Impact
178
-
179
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
180
-
181
- 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).
182
-
183
- - **Hardware Type:** More information needed
184
- - **Hours used:** More information needed
185
- - **Cloud Provider:** More information needed
186
- - **Compute Region:** More information needed
187
- - **Carbon Emitted:** More information needed
188
-
189
- # Technical Specifications [optional]
190
-
191
- ## Model Architecture and Objective
192
-
193
- More information needed
194
-
195
- ## Compute Infrastructure
196
-
197
- More information needed
198
-
199
- ### Hardware
200
-
201
- More information needed
202
-
203
- ### Software
204
-
205
- More information needed
206
-
207
- # Citation
208
-
209
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
210
-
211
- **BibTeX:**
212
-
213
- More information needed
214
-
215
- **APA:**
216
-
217
- More information needed
218
-
219
- # Glossary [optional]
220
-
221
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
222
-
223
- More information needed
224
-
225
- # More Information [optional]
226
-
227
- More information needed
228
-
229
- # Model Card Authors [optional]
230
-
231
- <!-- This section provides another layer of transparency and accountability. Whose views is this model card representing? How many voices were included in its construction? Etc. -->
232
-
233
- More information needed
234
-
235
- # Model Card Contact
236
-
237
- More information needed
238
-
239
- # How to Get Started with the Model
240
-
241
- Use the code below to get started with the model.
242
-
243
- <details>
244
- <summary> Click to expand </summary>
245
-
246
- More information needed
247
-
248
- </details>