Barnabiii commited on
Commit
e1e5271
·
verified ·
1 Parent(s): 025e513

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +3 -195
README.md CHANGED
@@ -4,199 +4,7 @@ language:
4
  - en
5
  ---
6
 
7
- # SwinUNETR
8
- ## Trained by Margerie Huet Dastarac
9
- ## Training date: November2023
10
 
11
- <!-- Provide a quick summary of what the model is/does. -->
12
-
13
- {{ model_summary | default("", true) }}
14
-
15
- ## Model Details
16
-
17
- ### Model Description
18
-
19
- <!-- Provide a longer summary of what this model is. -->
20
-
21
- {{ model_description | default("", true) }}
22
-
23
- - **Developed by:** {{ developers | default("[More Information Needed]", true)}}
24
- - **Funded by [optional]:** {{ funded_by | default("[More Information Needed]", true)}}
25
- - **Shared by [optional]:** {{ shared_by | default("[More Information Needed]", true)}}
26
- - **Model type:** {{ model_type | default("[More Information Needed]", true)}}
27
- - **Language(s) (NLP):** {{ language | default("[More Information Needed]", true)}}
28
- - **License:** {{ license | default("[More Information Needed]", true)}}
29
- **Finetuned from model [optional]:** {{ base_model | default("[More Information Needed]", true)}}
30
-
31
- ### Model Sources [optional]
32
-
33
- <!-- Provide the basic links for the model. -->
34
-
35
- - **Repository:** {{ repo | default("[More Information Needed]", true)}}
36
- - **Paper [optional]:** {{ paper | default("[More Information Needed]", true)}}
37
- - **Demo [optional]:** {{ demo | default("[More Information Needed]", true)}}
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
- {{ direct_use | default("[More Information Needed]", true)}}
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
- {{ downstream_use | default("[More Information Needed]", true)}}
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
- {{ out_of_scope_use | default("[More Information Needed]", true)}}
60
-
61
- ## Bias, Risks, and Limitations
62
-
63
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
64
-
65
- {{ bias_risks_limitations | default("[More Information Needed]", true)}}
66
-
67
- ### Recommendations
68
-
69
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
70
-
71
- {{ 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)}}
72
-
73
- ## How to Get Started with the Model
74
-
75
- Use the code below to get started with the model.
76
-
77
- {{ get_started_code | default("[More Information Needed]", true)}}
78
-
79
- ## Training Details
80
-
81
- ### Training Data
82
-
83
- <!-- 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. -->
84
-
85
- {{ training_data | default("[More Information Needed]", true)}}
86
-
87
- ### Training Procedure
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 [optional]
92
-
93
- {{ preprocessing | default("[More Information Needed]", true)}}
94
-
95
-
96
- #### Training Hyperparameters
97
-
98
- - **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 -->
99
-
100
- #### Speeds, Sizes, Times [optional]
101
-
102
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
103
-
104
- {{ speeds_sizes_times | default("[More Information Needed]", true)}}
105
-
106
- ## Evaluation
107
-
108
- <!-- This section describes the evaluation protocols and provides the results. -->
109
-
110
- ### Testing Data, Factors & Metrics
111
-
112
- #### Testing Data
113
-
114
- <!-- This should link to a Dataset Card if possible. -->
115
-
116
- {{ testing_data | default("[More Information Needed]", true)}}
117
-
118
- #### Factors
119
-
120
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
121
-
122
- {{ testing_factors | default("[More Information Needed]", true)}}
123
-
124
- #### Metrics
125
-
126
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
127
-
128
- {{ testing_metrics | default("[More Information Needed]", true)}}
129
-
130
- ### Results
131
-
132
- {{ results | default("[More Information Needed]", true)}}
133
-
134
- #### Summary
135
-
136
- {{ results_summary | default("", true) }}
137
-
138
- ## Model Examination [optional]
139
-
140
- <!-- Relevant interpretability work for the model goes here -->
141
-
142
- {{ model_examination | default("[More Information Needed]", true)}}
143
-
144
- ## Environmental Impact
145
-
146
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
147
-
148
- 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).
149
-
150
- - **Hardware Type:** {{ hardware_type | default("[More Information Needed]", true)}}
151
- - **Hours used:** {{ hours_used | default("[More Information Needed]", true)}}
152
- - **Cloud Provider:** {{ cloud_provider | default("[More Information Needed]", true)}}
153
- - **Compute Region:** {{ cloud_region | default("[More Information Needed]", true)}}
154
- - **Carbon Emitted:** {{ co2_emitted | default("[More Information Needed]", true)}}
155
-
156
- ## Technical Specifications [optional]
157
-
158
- ### Model Architecture and Objective
159
-
160
- {{ model_specs | default("[More Information Needed]", true)}}
161
-
162
- ### Compute Infrastructure
163
-
164
- {{ compute_infrastructure | default("[More Information Needed]", true)}}
165
-
166
- #### Hardware
167
-
168
- {{ hardware_requirements | default("[More Information Needed]", true)}}
169
-
170
- #### Software
171
-
172
- {{ software | default("[More Information Needed]", true)}}
173
-
174
- ## Citation [optional]
175
-
176
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
177
-
178
- **BibTeX:**
179
-
180
- {{ citation_bibtex | default("[More Information Needed]", true)}}
181
-
182
- **APA:**
183
-
184
- {{ citation_apa | default("[More Information Needed]", true)}}
185
-
186
- ## Glossary [optional]
187
-
188
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
189
-
190
- {{ glossary | default("[More Information Needed]", true)}}
191
-
192
- ## More Information [optional]
193
-
194
- {{ more_information | default("[More Information Needed]", true)}}
195
-
196
- ## Model Card Authors [optional]
197
-
198
- {{ model_card_authors | default("[More Information Needed]", true)}}
199
-
200
- ## Model Card Contact
201
-
202
- {{ model_card_contact | default("[More Information Needed]", true)}}
 
4
  - en
5
  ---
6
 
7
+ <h1 align="center">SwinUNETR</h1>
8
+ ### *Trained by Margerie Huet Dastarac*
9
+ ### *Training date: November2023*
10