ManiShankar-AlpesAi commited on
Commit
f4133c2
1 Parent(s): 9a670fd

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +196 -1
README.md CHANGED
@@ -1114,4 +1114,199 @@ model-index:
1114
  value: 82.74416973508781
1115
  - type: max_f1
1116
  value: 75.0812647754137
1117
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1114
  value: 82.74416973508781
1115
  - type: max_f1
1116
  value: 75.0812647754137
1117
+ ---
1118
+ # paraphrase-multilingual-mpnet-base-v2-KE_Sieve
1119
+
1120
+ <!-- Provide a quick summary of what the model is/does. -->
1121
+
1122
+ This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
1123
+
1124
+ ## Model Details
1125
+
1126
+ ### Model Description
1127
+
1128
+ <!-- Provide a longer summary of what this model is. -->
1129
+
1130
+
1131
+
1132
+ - **Developed by:** [More Information Needed]
1133
+ - **Shared by [optional]:** [More Information Needed]
1134
+ - **Model type:** [More Information Needed]
1135
+ - **Language(s) (NLP):** [More Information Needed]
1136
+ - **License:** [More Information Needed]
1137
+ - **Finetuned from model [optional]:** [More Information Needed]
1138
+
1139
+ ### Model Sources [optional]
1140
+
1141
+ <!-- Provide the basic links for the model. -->
1142
+
1143
+ - **Repository:** [More Information Needed]
1144
+ - **Paper [optional]:** [More Information Needed]
1145
+ - **Demo [optional]:** [More Information Needed]
1146
+
1147
+ ## Uses
1148
+
1149
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
1150
+
1151
+ ### Direct Use
1152
+
1153
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
1154
+
1155
+ [More Information Needed]
1156
+
1157
+ ### Downstream Use [optional]
1158
+
1159
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
1160
+
1161
+ [More Information Needed]
1162
+
1163
+ ### Out-of-Scope Use
1164
+
1165
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
1166
+
1167
+ [More Information Needed]
1168
+
1169
+ ## Bias, Risks, and Limitations
1170
+
1171
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
1172
+
1173
+ [More Information Needed]
1174
+
1175
+ ### Recommendations
1176
+
1177
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
1178
+
1179
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
1180
+
1181
+ ## How to Get Started with the Model
1182
+
1183
+ Use the code below to get started with the model.
1184
+
1185
+ [More Information Needed]
1186
+
1187
+ ## Training Details
1188
+
1189
+ ### Training Data
1190
+
1191
+ <!-- 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. -->
1192
+
1193
+ [More Information Needed]
1194
+
1195
+ ### Training Procedure
1196
+
1197
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
1198
+
1199
+ #### Preprocessing [optional]
1200
+
1201
+ [More Information Needed]
1202
+
1203
+
1204
+ #### Training Hyperparameters
1205
+
1206
+ - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
1207
+
1208
+ #### Speeds, Sizes, Times [optional]
1209
+
1210
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
1211
+
1212
+ [More Information Needed]
1213
+
1214
+ ## Evaluation
1215
+
1216
+ <!-- This section describes the evaluation protocols and provides the results. -->
1217
+
1218
+ ### Testing Data, Factors & Metrics
1219
+
1220
+ #### Testing Data
1221
+
1222
+ <!-- This should link to a Data Card if possible. -->
1223
+
1224
+ [More Information Needed]
1225
+
1226
+ #### Factors
1227
+
1228
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
1229
+
1230
+ [More Information Needed]
1231
+
1232
+ #### Metrics
1233
+
1234
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
1235
+
1236
+ [More Information Needed]
1237
+
1238
+ ### Results
1239
+
1240
+ [More Information Needed]
1241
+
1242
+ #### Summary
1243
+
1244
+
1245
+
1246
+ ## Model Examination [optional]
1247
+
1248
+ <!-- Relevant interpretability work for the model goes here -->
1249
+
1250
+ [More Information Needed]
1251
+
1252
+ ## Environmental Impact
1253
+
1254
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
1255
+
1256
+ 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).
1257
+
1258
+ - **Hardware Type:** [More Information Needed]
1259
+ - **Hours used:** [More Information Needed]
1260
+ - **Cloud Provider:** [More Information Needed]
1261
+ - **Compute Region:** [More Information Needed]
1262
+ - **Carbon Emitted:** [More Information Needed]
1263
+
1264
+ ## Technical Specifications [optional]
1265
+
1266
+ ### Model Architecture and Objective
1267
+
1268
+ [More Information Needed]
1269
+
1270
+ ### Compute Infrastructure
1271
+
1272
+ [More Information Needed]
1273
+
1274
+ #### Hardware
1275
+
1276
+ [More Information Needed]
1277
+
1278
+ #### Software
1279
+
1280
+ [More Information Needed]
1281
+
1282
+ ## Citation [optional]
1283
+
1284
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
1285
+
1286
+ **BibTeX:**
1287
+
1288
+ [More Information Needed]
1289
+
1290
+ **APA:**
1291
+
1292
+ [More Information Needed]
1293
+
1294
+ ## Glossary [optional]
1295
+
1296
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
1297
+
1298
+ [More Information Needed]
1299
+
1300
+ ## More Information [optional]
1301
+
1302
+ [More Information Needed]
1303
+
1304
+ ## Model Card Authors [optional]
1305
+
1306
+ [More Information Needed]
1307
+
1308
+ ## Model Card Contact
1309
+
1310
+ [More Information Needed]
1311
+
1312
+