Niceforo commited on
Commit
3cd506a
1 Parent(s): 7047946

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +194 -0
README.md CHANGED
@@ -1,3 +1,197 @@
1
  ---
2
  license: openrail
 
 
 
 
 
 
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: openrail
3
+ language:
4
+ - pt
5
+ - en
6
+ pipeline_tag: image-segmentation
7
+ tags:
8
+ - art
9
  ---
10
+ # Model Card for Model ID
11
+
12
+ <!-- Provide a quick summary of what the model is/does. -->
13
+
14
+ 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).
15
+
16
+ # Model Details
17
+
18
+ ## Model Description
19
+
20
+ <!-- Provide a longer summary of what this model is. -->
21
+
22
+
23
+
24
+ - **Developed by:** [More Information Needed]
25
+ - **Shared by [optional]:** [More Information Needed]
26
+ - **Model type:** [More Information Needed]
27
+ - **Language(s) (NLP):** [More Information Needed]
28
+ - **License:** [More Information Needed]
29
+ - **Finetuned from model [optional]:** [More Information Needed]
30
+
31
+ ## Model Sources [optional]
32
+
33
+ <!-- Provide the basic links for the model. -->
34
+
35
+ - **Repository:** [More Information Needed]
36
+ - **Paper [optional]:** [More Information Needed]
37
+ - **Demo [optional]:** [More Information Needed]
38
+
39
+ # Uses
40
+
41
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
42
+
43
+ ## Direct Use
44
+
45
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
46
+
47
+ [More Information Needed]
48
+
49
+ ## Downstream Use [optional]
50
+
51
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
52
+
53
+ [More Information Needed]
54
+
55
+ ## Out-of-Scope Use
56
+
57
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
58
+
59
+ [More Information Needed]
60
+
61
+ # Bias, Risks, and Limitations
62
+
63
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
64
+
65
+ [More Information Needed]
66
+
67
+ ## Recommendations
68
+
69
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
70
+
71
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
72
+
73
+ ## How to Get Started with the Model
74
+
75
+ Use the code below to get started with the model.
76
+
77
+ [More Information Needed]
78
+
79
+ # Training Details
80
+
81
+ ## Training Data
82
+
83
+ <!-- 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. -->
84
+
85
+ [More Information Needed]
86
+
87
+ ## Training Procedure [optional]
88
+
89
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
90
+
91
+ ### Preprocessing
92
+
93
+ [More Information Needed]
94
+
95
+ ### Speeds, Sizes, Times
96
+
97
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
98
+
99
+ [More Information Needed]
100
+
101
+ # Evaluation
102
+
103
+ <!-- This section describes the evaluation protocols and provides the results. -->
104
+
105
+ ## Testing Data, Factors & Metrics
106
+
107
+ ### Testing Data
108
+
109
+ <!-- This should link to a Data Card if possible. -->
110
+
111
+ [More Information Needed]
112
+
113
+ ### Factors
114
+
115
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
116
+
117
+ [More Information Needed]
118
+
119
+ ### Metrics
120
+
121
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
122
+
123
+ [More Information Needed]
124
+
125
+ ## Results
126
+
127
+ [More Information Needed]
128
+
129
+ ### Summary
130
+
131
+
132
+
133
+ # Model Examination [optional]
134
+
135
+ <!-- Relevant interpretability work for the model goes here -->
136
+
137
+ [More Information Needed]
138
+
139
+ # Environmental Impact
140
+
141
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
142
+
143
+ 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).
144
+
145
+ - **Hardware Type:** [More Information Needed]
146
+ - **Hours used:** [More Information Needed]
147
+ - **Cloud Provider:** [More Information Needed]
148
+ - **Compute Region:** [More Information Needed]
149
+ - **Carbon Emitted:** [More Information Needed]
150
+
151
+ # Technical Specifications [optional]
152
+
153
+ ## Model Architecture and Objective
154
+
155
+ [More Information Needed]
156
+
157
+ ## Compute Infrastructure
158
+
159
+ [More Information Needed]
160
+
161
+ ### Hardware
162
+
163
+ [More Information Needed]
164
+
165
+ ### Software
166
+
167
+ [More Information Needed]
168
+
169
+ # Citation [optional]
170
+
171
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
172
+
173
+ **BibTeX:**
174
+
175
+ [More Information Needed]
176
+
177
+ **APA:**
178
+
179
+ [More Information Needed]
180
+
181
+ # Glossary [optional]
182
+
183
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
184
+
185
+ [More Information Needed]
186
+
187
+ # More Information [optional]
188
+
189
+ [More Information Needed]
190
+
191
+ # Model Card Authors [optional]
192
+
193
+ [More Information Needed]
194
+
195
+ # Model Card Contact
196
+
197
+ [More Information Needed]