Update README.md
Browse files
README.md
CHANGED
|
@@ -6,6 +6,8 @@ tags:
|
|
| 6 |
- biology
|
| 7 |
---
|
| 8 |
|
|
|
|
|
|
|
| 9 |
### BibTeX entry and citation info
|
| 10 |
|
| 11 |
```bibtex
|
|
@@ -23,12 +25,6 @@ tags:
|
|
| 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
|
|
@@ -45,13 +41,6 @@ tags:
|
|
| 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 |
|
|
@@ -75,115 +64,16 @@ tags:
|
|
| 75 |
|
| 76 |
{{ out_of_scope_use | default("[More Information Needed]", true)}}
|
| 77 |
|
| 78 |
-
##
|
| 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 |
-
|
| 182 |
|
| 183 |
-
|
| 184 |
|
| 185 |
-
|
| 186 |
|
| 187 |
-
|
| 188 |
|
| 189 |
-
|
|
|
|
| 6 |
- biology
|
| 7 |
---
|
| 8 |
|
| 9 |
+
# Model Card for Phikon
|
| 10 |
+
|
| 11 |
### BibTeX entry and citation info
|
| 12 |
|
| 13 |
```bibtex
|
|
|
|
| 25 |
```
|
| 26 |
---
|
| 27 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 28 |
## Model Details
|
| 29 |
|
| 30 |
### Model Description
|
|
|
|
| 41 |
- **License:** {{ license | default("[More Information Needed]", true)}}
|
| 42 |
- **Finetuned from model [optional]:** {{ finetuned_from | default("[More Information Needed]", true)}}
|
| 43 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 44 |
|
| 45 |
## Uses
|
| 46 |
|
|
|
|
| 64 |
|
| 65 |
{{ out_of_scope_use | default("[More Information Needed]", true)}}
|
| 66 |
|
| 67 |
+
## Technical Specifications
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 68 |
|
| 69 |
### Compute Infrastructure
|
| 70 |
|
| 71 |
+
All the models we built were trained on the French Jean Zay cluster
|
| 72 |
|
| 73 |
+
### Hardware
|
| 74 |
|
| 75 |
+
NVIDIA V100 GPUs with 32Gb RAM
|
| 76 |
|
| 77 |
+
### Software
|
| 78 |
|
| 79 |
+
PyTorch 1.13.1
|