AGarioud commited on
Commit
a4fd9ca
1 Parent(s): 7bf16ce

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +154 -1
README.md CHANGED
@@ -21,4 +21,157 @@ model-index:
21
  type: IoU
22
  value: 82.3
23
  pipeline_tag: image-segmentation
24
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
21
  type: IoU
22
  value: 82.3
23
  pipeline_tag: image-segmentation
24
+ ---
25
+
26
+
27
+
28
+ Lorem ipsum dolor sit amet. Hic galisum tenetur et perspiciatis odit et aliquid perferendis ut galisum quisquam.
29
+ Ad veritatis optio ut quaerat tempora sit quae tenetur et quam iste! Et mollitia natus eum facere debitis ut nisi voluptatum qui voluptas iusto hic adipisci voluptas
30
+ ab reiciendis fuga id nisi quia.
31
+
32
+ Aut omnis architecto ut quis culpa quo molestiae animi sit explicabo quae ea necessitatibus magni.
33
+ Et voluptatem velit et quia laudantium aut voluptatem fugit aut labore consequatur et maxime eius aut perferendis placeat.
34
+ Vel expedita tenetur et dolores cupiditate sed dolorum ratione id quia odio quo sint molestiae ut dicta quos.
35
+
36
+ Ut iste unde in delectus quia aut reiciendis voluptatem ut voluptatem velit et dolore quia rem quia accusamus.
37
+ Ab maiores tempore 33 deleniti ipsam a molestiae dolor eos optio optio aut perferendis quasi et expedita ipsum vel similique accusamus.
38
+
39
+
40
+ # Model Card for {{ model_id | default("Model ID", true) }}
41
+
42
+ <!-- Provide a quick summary of what the model is/does. -->
43
+
44
+ {{ model_summary | default("", true) }}
45
+
46
+ ## Model Details
47
+
48
+ ### Model Description
49
+
50
+ <!-- Provide a longer summary of what this model is. -->
51
+
52
+ - **Developed by:** {{ developers | default("[More Information Needed]", true)}}
53
+ - **Funded by [optional]:** {{ funded_by | default("[More Information Needed]", true)}}
54
+ - **Shared by [optional]:** {{ shared_by | default("[More Information Needed]", true)}}
55
+ - **Model type:** {{ model_type | default("[More Information Needed]", true)}}
56
+ - **Language(s) (NLP):** {{ language | default("[More Information Needed]", true)}}
57
+ - **License:** {{ license | default("[More Information Needed]", true)}}
58
+ - **Finetuned from model [optional]:** {{ base_model | default("[More Information Needed]", true)}}
59
+
60
+ ### Model Sources [optional]
61
+
62
+ <!-- Provide the basic links for the model. -->
63
+
64
+ - **Repository:** {{ repo | default("[More Information Needed]", true)}}
65
+ - **Paper [optional]:** {{ paper | default("[More Information Needed]", true)}}
66
+ - **Demo [optional]:** {{ demo | default("[More Information Needed]", true)}}
67
+
68
+ ## Uses
69
+
70
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
71
+
72
+
73
+ ## Bias, Risks, and Limitations
74
+
75
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
76
+
77
+ {{ bias_risks_limitations | default("[More Information Needed]", true)}}
78
+
79
+ ### Recommendations
80
+
81
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
82
+
83
+ {{ bias_recommendations | default("Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.", true)}}
84
+
85
+ ## How to Get Started with the Model
86
+
87
+ Use the code below to get started with the model.
88
+
89
+ {{ get_started_code | default("[More Information Needed]", true)}}
90
+
91
+ ## Training Details
92
+
93
+ ### Training Data
94
+
95
+ <!-- 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. -->
96
+
97
+ {{ training_data | default("[More Information Needed]", true)}}
98
+
99
+ ### Training Procedure
100
+
101
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
102
+
103
+ #### Preprocessing [optional]
104
+
105
+ {{ preprocessing | default("[More Information Needed]", true)}}
106
+
107
+
108
+ #### Training Hyperparameters
109
+
110
+ - **Training regime:** {{ training_regime | default("[More Information Needed]", true)}} <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
111
+
112
+ #### Speeds, Sizes, Times [optional]
113
+
114
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
115
+
116
+ {{ speeds_sizes_times | default("[More Information Needed]", true)}}
117
+
118
+ ## Evaluation
119
+
120
+ <!-- This section describes the evaluation protocols and provides the results. -->
121
+
122
+ ### Testing Data, Factors & Metrics
123
+
124
+ #### Testing Data
125
+
126
+ <!-- This should link to a Dataset Card if possible. -->
127
+
128
+ {{ testing_data | default("[More Information Needed]", true)}}
129
+
130
+ #### Metrics
131
+
132
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
133
+
134
+ {{ testing_metrics | default("[More Information Needed]", true)}}
135
+
136
+ ### Results
137
+
138
+ {{ results | default("[More Information Needed]", true)}}
139
+
140
+ #### Summary
141
+
142
+ {{ results_summary | default("", true) }}
143
+
144
+
145
+ ## Technical Specifications [optional]
146
+
147
+ ### Model Architecture and Objective
148
+
149
+ {{ model_specs | default("[More Information Needed]", true)}}
150
+
151
+ ### Compute Infrastructure
152
+
153
+ {{ compute_infrastructure | default("[More Information Needed]", true)}}
154
+
155
+ #### Hardware
156
+
157
+ {{ hardware_requirements | default("[More Information Needed]", true)}}
158
+
159
+ #### Software
160
+
161
+ {{ software | default("[More Information Needed]", true)}}
162
+
163
+ ## Citation [optional]
164
+
165
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
166
+
167
+ **BibTeX:**
168
+
169
+ {{ citation_bibtex | default("[More Information Needed]", true)}}
170
+
171
+ **APA:**
172
+
173
+ {{ citation_apa | default("[More Information Needed]", true)}}
174
+
175
+ ## Model Card Contact
176
+
177
+ {{ model_card_contact | default("[More Information Needed]", true)}}