Update README.md
Browse files
README.md
CHANGED
@@ -21,8 +21,169 @@ tags:
|
|
21 |
journal = {medRxiv}
|
22 |
}
|
23 |
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
24 |
|
25 |
-
|
26 |
-
- Try to link this repository to the medrxiv paper ?
|
27 |
-
- Do we link to cam16-features even though it's not the pre-training dataset ?
|
28 |
-
- Delte the ``ibot_vit_base_pancancer.pth`` in the repository.
|
|
|
21 |
journal = {medRxiv}
|
22 |
}
|
23 |
```
|
24 |
+
---
|
25 |
+
|
26 |
+
# Model Card for {{ model_id | default("Model ID", true) }}
|
27 |
+
|
28 |
+
<!-- Provide a quick summary of what the model is/does. -->
|
29 |
+
|
30 |
+
{{ model_summary | default("", true) }}
|
31 |
+
|
32 |
+
## Model Details
|
33 |
+
|
34 |
+
### Model Description
|
35 |
+
|
36 |
+
<!-- Provide a longer summary of what this model is. -->
|
37 |
+
|
38 |
+
{{ model_description | default("", true) }}
|
39 |
+
|
40 |
+
- **Developed by:** {{ developers | default("[More Information Needed]", true)}}
|
41 |
+
- **Funded by [optional]:** {{ funded_by | default("[More Information Needed]", true)}}
|
42 |
+
- **Shared by [optional]:** {{ shared_by | default("[More Information Needed]", true)}}
|
43 |
+
- **Model type:** {{ model_type | default("[More Information Needed]", true)}}
|
44 |
+
- **Language(s) (NLP):** {{ language | default("[More Information Needed]", true)}}
|
45 |
+
- **License:** {{ license | default("[More Information Needed]", true)}}
|
46 |
+
- **Finetuned from model [optional]:** {{ finetuned_from | default("[More Information Needed]", true)}}
|
47 |
+
|
48 |
+
### Model Sources [optional]
|
49 |
+
|
50 |
+
<!-- Provide the basic links for the model. -->
|
51 |
+
|
52 |
+
- **Repository:** {{ repo | default("[More Information Needed]", true)}}
|
53 |
+
- **Paper [optional]:** {{ paper | default("[More Information Needed]", true)}}
|
54 |
+
- **Demo [optional]:** {{ demo | default("[More Information Needed]", true)}}
|
55 |
+
|
56 |
+
## Uses
|
57 |
+
|
58 |
+
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
59 |
+
|
60 |
+
### Direct Use
|
61 |
+
|
62 |
+
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
63 |
+
|
64 |
+
{{ direct_use | default("[More Information Needed]", true)}}
|
65 |
+
|
66 |
+
### Downstream Use [optional]
|
67 |
+
|
68 |
+
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
69 |
+
|
70 |
+
{{ downstream_use | default("[More Information Needed]", true)}}
|
71 |
+
|
72 |
+
### Out-of-Scope Use
|
73 |
+
|
74 |
+
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
75 |
+
|
76 |
+
{{ out_of_scope_use | default("[More Information Needed]", true)}}
|
77 |
+
|
78 |
+
## Bias, Risks, and Limitations
|
79 |
+
|
80 |
+
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
81 |
+
|
82 |
+
{{ bias_risks_limitations | default("[More Information Needed]", true)}}
|
83 |
+
|
84 |
+
### Recommendations
|
85 |
+
|
86 |
+
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
87 |
+
|
88 |
+
{{ 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)}}
|
89 |
+
|
90 |
+
## How to Get Started with the Model
|
91 |
+
|
92 |
+
Use the code below to get started with the model.
|
93 |
+
|
94 |
+
{{ get_started_code | default("[More Information Needed]", true)}}
|
95 |
+
|
96 |
+
## Training Details
|
97 |
+
|
98 |
+
### Training Data
|
99 |
+
|
100 |
+
<!-- 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. -->
|
101 |
+
|
102 |
+
{{ training_data | default("[More Information Needed]", true)}}
|
103 |
+
|
104 |
+
### Training Procedure
|
105 |
+
|
106 |
+
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
107 |
+
|
108 |
+
#### Preprocessing [optional]
|
109 |
+
|
110 |
+
{{ preprocessing | default("[More Information Needed]", true)}}
|
111 |
+
|
112 |
+
|
113 |
+
#### Training Hyperparameters
|
114 |
+
|
115 |
+
- **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 -->
|
116 |
+
|
117 |
+
#### Speeds, Sizes, Times [optional]
|
118 |
+
|
119 |
+
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
120 |
+
|
121 |
+
{{ speeds_sizes_times | default("[More Information Needed]", true)}}
|
122 |
+
|
123 |
+
## Evaluation
|
124 |
+
|
125 |
+
<!-- This section describes the evaluation protocols and provides the results. -->
|
126 |
+
|
127 |
+
### Testing Data, Factors & Metrics
|
128 |
+
|
129 |
+
#### Testing Data
|
130 |
+
|
131 |
+
<!-- This should link to a Dataset Card if possible. -->
|
132 |
+
|
133 |
+
{{ testing_data | default("[More Information Needed]", true)}}
|
134 |
+
|
135 |
+
#### Factors
|
136 |
+
|
137 |
+
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
138 |
+
|
139 |
+
{{ testing_factors | default("[More Information Needed]", true)}}
|
140 |
+
|
141 |
+
#### Metrics
|
142 |
+
|
143 |
+
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
144 |
+
|
145 |
+
{{ testing_metrics | default("[More Information Needed]", true)}}
|
146 |
+
|
147 |
+
### Results
|
148 |
+
|
149 |
+
{{ results | default("[More Information Needed]", true)}}
|
150 |
+
|
151 |
+
#### Summary
|
152 |
+
|
153 |
+
{{ results_summary | default("", true) }}
|
154 |
+
|
155 |
+
## Model Examination [optional]
|
156 |
+
|
157 |
+
<!-- Relevant interpretability work for the model goes here -->
|
158 |
+
|
159 |
+
{{ model_examination | default("[More Information Needed]", true)}}
|
160 |
+
|
161 |
+
## Environmental Impact
|
162 |
+
|
163 |
+
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
164 |
+
|
165 |
+
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).
|
166 |
+
|
167 |
+
- **Hardware Type:** {{ hardware | default("[More Information Needed]", true)}}
|
168 |
+
- **Hours used:** {{ hours_used | default("[More Information Needed]", true)}}
|
169 |
+
- **Cloud Provider:** {{ cloud_provider | default("[More Information Needed]", true)}}
|
170 |
+
- **Compute Region:** {{ cloud_region | default("[More Information Needed]", true)}}
|
171 |
+
- **Carbon Emitted:** {{ co2_emitted | default("[More Information Needed]", true)}}
|
172 |
+
|
173 |
+
## Technical Specifications [optional]
|
174 |
+
|
175 |
+
### Model Architecture and Objective
|
176 |
+
|
177 |
+
{{ model_specs | default("[More Information Needed]", true)}}
|
178 |
+
|
179 |
+
### Compute Infrastructure
|
180 |
+
|
181 |
+
{{ compute_infrastructure | default("[More Information Needed]", true)}}
|
182 |
+
|
183 |
+
#### Hardware
|
184 |
+
|
185 |
+
{{ hardware | default("[More Information Needed]", true)}}
|
186 |
+
|
187 |
+
#### Software
|
188 |
|
189 |
+
{{ software | default("[More Information Needed]", true)}}
|
|
|
|
|
|