eduagarcia ju-resplande commited on
Commit
9f30b29
1 Parent(s): 7f33d97

Update README.md (#3)

Browse files

- Update README.md (bf46cc71818b6afefdf4f7960995e1a9cf5f1b8e)


Co-authored-by: Juliana Resplande <ju-resplande@users.noreply.huggingface.co>

Files changed (1) hide show
  1. README.md +8 -122
README.md CHANGED
@@ -52,7 +52,7 @@ license: cc-by-4.0
52
  metrics:
53
  - seqeval
54
  ---
55
- # Model Card for Model ID
56
 
57
  <!-- Provide a quick summary of what the model is/does. -->
58
 
@@ -64,63 +64,16 @@ This modelcard aims to be a base template for new models. It has been generated
64
 
65
  <!-- Provide a longer summary of what this model is. -->
66
 
67
-
68
-
69
  - **Developed by:** [More Information Needed]
70
- - **Funded by [optional]:** [More Information Needed]
71
- - **Shared by [optional]:** [More Information Needed]
72
  - **Model type:** [More Information Needed]
73
- - **Language(s) (NLP):** [More Information Needed]
74
- - **License:** [More Information Needed]
75
- - **Finetuned from model [optional]:** [More Information Needed]
76
-
77
- ### Model Sources [optional]
78
-
79
- <!-- Provide the basic links for the model. -->
80
-
81
- - **Repository:** [More Information Needed]
82
- - **Paper [optional]:** [More Information Needed]
83
- - **Demo [optional]:** [More Information Needed]
84
-
85
- ## Uses
86
-
87
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
88
-
89
- ### Direct Use
90
-
91
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
92
 
93
- [More Information Needed]
94
-
95
- ### Downstream Use [optional]
96
-
97
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
98
-
99
- [More Information Needed]
100
-
101
- ### Out-of-Scope Use
102
-
103
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
104
-
105
- [More Information Needed]
106
 
107
- ## Bias, Risks, and Limitations
108
-
109
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
110
-
111
- [More Information Needed]
112
-
113
- ### Recommendations
114
-
115
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
116
-
117
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
118
-
119
- ## How to Get Started with the Model
120
-
121
- Use the code below to get started with the model.
122
-
123
- [More Information Needed]
124
 
125
  ## Training Details
126
 
@@ -161,12 +114,6 @@ Use the code below to get started with the model.
161
 
162
  [More Information Needed]
163
 
164
- #### Factors
165
-
166
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
167
-
168
- [More Information Needed]
169
-
170
  #### Metrics
171
 
172
  <!-- These are the evaluation metrics being used, ideally with a description of why. -->
@@ -180,69 +127,8 @@ Use the code below to get started with the model.
180
  #### Summary
181
 
182
 
183
-
184
- ## Model Examination [optional]
185
-
186
- <!-- Relevant interpretability work for the model goes here -->
187
-
188
- [More Information Needed]
189
-
190
- ## Environmental Impact
191
-
192
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
193
-
194
- 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).
195
-
196
- - **Hardware Type:** [More Information Needed]
197
- - **Hours used:** [More Information Needed]
198
- - **Cloud Provider:** [More Information Needed]
199
- - **Compute Region:** [More Information Needed]
200
- - **Carbon Emitted:** [More Information Needed]
201
-
202
- ## Technical Specifications [optional]
203
-
204
- ### Model Architecture and Objective
205
-
206
- [More Information Needed]
207
-
208
- ### Compute Infrastructure
209
-
210
- [More Information Needed]
211
-
212
- #### Hardware
213
-
214
- [More Information Needed]
215
-
216
- #### Software
217
-
218
- [More Information Needed]
219
-
220
- ## Citation [optional]
221
 
222
  <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
223
 
224
- **BibTeX:**
225
-
226
- [More Information Needed]
227
-
228
- **APA:**
229
-
230
- [More Information Needed]
231
-
232
- ## Glossary [optional]
233
-
234
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
235
-
236
  [More Information Needed]
237
-
238
- ## More Information [optional]
239
-
240
- [More Information Needed]
241
-
242
- ## Model Card Authors [optional]
243
-
244
- [More Information Needed]
245
-
246
- ## Model Card Contact
247
-
248
- [More Information Needed]
 
52
  metrics:
53
  - seqeval
54
  ---
55
+ # RoBERTaLexPT-base
56
 
57
  <!-- Provide a quick summary of what the model is/does. -->
58
 
 
64
 
65
  <!-- Provide a longer summary of what this model is. -->
66
 
 
 
67
  - **Developed by:** [More Information Needed]
68
+ - **Funded by:** [More Information Needed]
 
69
  - **Model type:** [More Information Needed]
70
+ - **Language(s) (NLP):** Brazilian Portuguese - pt-BR
71
+ - **License:** [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/deed.en)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
72
 
73
+ ### Model Sources
 
 
 
 
 
 
 
 
 
 
 
 
74
 
75
+ - **Repository:** https://github.com/eduagarcia/roberta-legal-portuguese
76
+ - **Paper:** [More Information Needed]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
77
 
78
  ## Training Details
79
 
 
114
 
115
  [More Information Needed]
116
 
 
 
 
 
 
 
117
  #### Metrics
118
 
119
  <!-- These are the evaluation metrics being used, ideally with a description of why. -->
 
127
  #### Summary
128
 
129
 
130
+ ## Citation
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
131
 
132
  <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
133
 
 
 
 
 
 
 
 
 
 
 
 
 
134
  [More Information Needed]