Update README.md
Browse files
README.md
CHANGED
|
@@ -98,6 +98,44 @@ Installing torch can be the most complex part
|
|
| 98 |
|
| 99 |
|
| 100 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 101 |
|
| 102 |
### Downloading this repository
|
| 103 |
|
|
@@ -164,78 +202,6 @@ We provided code to test Phosformer-ST (see section below)
|
|
| 164 |
:tada: you are know ready to run the code :tada:
|
| 165 |
|
| 166 |
|
| 167 |
-
|
| 168 |
-
|
| 169 |
-
|
| 170 |
-
### Model Description
|
| 171 |
-
|
| 172 |
-
<!-- Provide a longer summary of what this model is. -->
|
| 173 |
-
|
| 174 |
-
|
| 175 |
-
|
| 176 |
-
- **Developed by:** [Nathan Gravel]
|
| 177 |
-
- **Funded by [optional]:** [NIH]
|
| 178 |
-
- **Shared by [optional]:** [More Information Neede]
|
| 179 |
-
- **Model type:** [Text classication]
|
| 180 |
-
- **Language(s) (NLP):** [Protein Sequence]
|
| 181 |
-
- **License:** [MIT]
|
| 182 |
-
- **Finetuned from model [optional]:** [ESM-2 150M]
|
| 183 |
-
|
| 184 |
-
### Model Sources [optional]
|
| 185 |
-
|
| 186 |
-
|
| 187 |
-
|
| 188 |
-
| Repo | Link | Discription|
|
| 189 |
-
| ------------- | ------------- |------------------------------------------|
|
| 190 |
-
| GitHub | [github version Data_cur](https://github.com/gravelCompBio/Claspp_data_cur/tree/main) | This verstion contains code but needs the to run the code to generate all the helper-files (will take some time run this code)|
|
| 191 |
-
| Zenodo | [zenodo version Data_cur](https://github.com/gravelCompBio/Claspp_data_cur/tree/main) | This version contains code and helper files already genrated. mostly for proof of concept and seeing the all the data intermeidate states |
|
| 192 |
-
| GitHub | [github version Forward](https://github.com/gravelCompBio/Claspp_data_cur/tree/main) | This verstion contains code but NOT any weights (file to big)|
|
| 193 |
-
| Huggingface | [huggingface version Forward](https://huggingface.co/gravelcompbio/Claspp) | This verstion contains code and training weights |
|
| 194 |
-
| Zenodo | [zenodo version training_data](https://github.com/gravelCompBio/Claspp_data_cur/tree/main) | zenodo version of training/testing/validation data|
|
| 195 |
-
| Hugingface | [huggingface version training_data](https://github.com/gravelCompBio/Claspp_data_cur/tree/main) | huggingface version of training/testing/validation data|
|
| 196 |
-
| Hugingface | [gradio lab webtool](https://github.com/gravelCompBio/Claspp_data_cur/tree/main) | webtool hosted on gradio lab (huggingface)|
|
| 197 |
-
| webtool | [website version of webtool](https://github.com/gravelCompBio/Claspp_data_cur/tree/main) | wettool hosted on a server|
|
| 198 |
-
|
| 199 |
-
- **Repository:** [More Information Needed]
|
| 200 |
-
- **Paper [optional]:** [More Information Needed]
|
| 201 |
-
- **Demo [optional]:** [More Information Needed]
|
| 202 |
-
|
| 203 |
-
## Uses
|
| 204 |
-
|
| 205 |
-
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
| 206 |
-
|
| 207 |
-
### Direct Use
|
| 208 |
-
|
| 209 |
-
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
| 210 |
-
|
| 211 |
-
[More Information Needed]
|
| 212 |
-
|
| 213 |
-
### Downstream Use [optional]
|
| 214 |
-
|
| 215 |
-
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
| 216 |
-
|
| 217 |
-
[More Information Needed]
|
| 218 |
-
|
| 219 |
-
### Out-of-Scope Use
|
| 220 |
-
|
| 221 |
-
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
| 222 |
-
|
| 223 |
-
[More Information Needed]
|
| 224 |
-
|
| 225 |
-
## Bias, Risks, and Limitations
|
| 226 |
-
|
| 227 |
-
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
| 228 |
-
|
| 229 |
-
[More Information Needed]
|
| 230 |
-
|
| 231 |
-
### Recommendations
|
| 232 |
-
|
| 233 |
-
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
| 234 |
-
|
| 235 |
-
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
| 236 |
-
|
| 237 |
-
## How to Get Started with the Model
|
| 238 |
-
|
| 239 |
Use the code below to get started with the model.
|
| 240 |
|
| 241 |
[More Information Needed]
|
|
@@ -261,79 +227,14 @@ Use the code below to get started with the model.
|
|
| 261 |
|
| 262 |
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
| 263 |
|
| 264 |
-
#### Speeds, Sizes, Times [optional]
|
| 265 |
-
|
| 266 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
| 267 |
-
|
| 268 |
-
[More Information Needed]
|
| 269 |
-
|
| 270 |
-
## Evaluation
|
| 271 |
-
|
| 272 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
| 273 |
-
|
| 274 |
-
### Testing Data, Factors & Metrics
|
| 275 |
-
|
| 276 |
-
#### Testing Data
|
| 277 |
-
|
| 278 |
-
<!-- This should link to a Dataset Card if possible. -->
|
| 279 |
-
|
| 280 |
-
[More Information Needed]
|
| 281 |
-
|
| 282 |
-
#### Factors
|
| 283 |
-
|
| 284 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
| 285 |
-
|
| 286 |
-
[More Information Needed]
|
| 287 |
-
|
| 288 |
-
#### Metrics
|
| 289 |
-
|
| 290 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
| 291 |
-
|
| 292 |
-
[More Information Needed]
|
| 293 |
-
|
| 294 |
-
### Results
|
| 295 |
-
|
| 296 |
-
[More Information Needed]
|
| 297 |
-
|
| 298 |
-
#### Summary
|
| 299 |
-
|
| 300 |
-
|
| 301 |
-
|
| 302 |
-
## Model Examination [optional]
|
| 303 |
-
|
| 304 |
-
<!-- Relevant interpretability work for the model goes here -->
|
| 305 |
-
|
| 306 |
-
[More Information Needed]
|
| 307 |
-
|
| 308 |
-
## Environmental Impact
|
| 309 |
-
|
| 310 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
| 311 |
-
|
| 312 |
-
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).
|
| 313 |
-
|
| 314 |
-
- **Hardware Type:** [More Information Needed]
|
| 315 |
-
- **Hours used:** [More Information Needed]
|
| 316 |
-
- **Cloud Provider:** [More Information Needed]
|
| 317 |
-
- **Compute Region:** [More Information Needed]
|
| 318 |
-
- **Carbon Emitted:** [More Information Needed]
|
| 319 |
|
| 320 |
-
|
| 321 |
|
| 322 |
-
|
| 323 |
|
| 324 |
[More Information Needed]
|
| 325 |
|
| 326 |
-
### Compute Infrastructure
|
| 327 |
|
| 328 |
-
[More Information Needed]
|
| 329 |
-
|
| 330 |
-
#### Hardware
|
| 331 |
-
|
| 332 |
-
[More Information Needed]
|
| 333 |
-
|
| 334 |
-
#### Software
|
| 335 |
-
|
| 336 |
-
[More Information Needed]
|
| 337 |
|
| 338 |
## Citation [optional]
|
| 339 |
|
|
@@ -347,20 +248,17 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
|
|
| 347 |
|
| 348 |
[More Information Needed]
|
| 349 |
|
| 350 |
-
## Glossary [optional]
|
| 351 |
|
| 352 |
-
<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
|
| 353 |
|
| 354 |
-
[More Information Needed]
|
| 355 |
|
| 356 |
-
## More Information [optional]
|
| 357 |
-
|
| 358 |
-
[More Information Needed]
|
| 359 |
|
| 360 |
-
## Model Card Authors [optional]
|
| 361 |
|
| 362 |
-
[
|
| 363 |
-
|
| 364 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 365 |
|
| 366 |
[More Information Needed]
|
|
|
|
| 98 |
|
| 99 |
|
| 100 |
|
| 101 |
+
### Model Sources [optional]
|
| 102 |
+
|
| 103 |
+
|
| 104 |
+
|
| 105 |
+
| Repo | Link | Discription|
|
| 106 |
+
| ------------- | ------------- |------------------------------------------|
|
| 107 |
+
| GitHub | [github version Data_cur](https://github.com/gravelCompBio/Claspp_data_cur/tree/main) | This verstion contains code but needs the to run the code to generate all the helper-files (will take some time run this code)|
|
| 108 |
+
| Zenodo | [zenodo version Data_cur](https://github.com/gravelCompBio/Claspp_data_cur/tree/main) | This version contains code and helper files already genrated. mostly for proof of concept and seeing the all the data intermeidate states |
|
| 109 |
+
| GitHub | [github version Forward](https://github.com/gravelCompBio/Claspp_data_cur/tree/main) | This verstion contains code but NOT any weights (file to big)|
|
| 110 |
+
| Huggingface | [huggingface version Forward](https://huggingface.co/gravelcompbio/Claspp) | This verstion contains code and training weights |
|
| 111 |
+
| Zenodo | [zenodo version training_data](https://github.com/gravelCompBio/Claspp_data_cur/tree/main) | zenodo version of training/testing/validation data|
|
| 112 |
+
| Hugingface | [huggingface version training_data](https://github.com/gravelCompBio/Claspp_data_cur/tree/main) | huggingface version of training/testing/validation data|
|
| 113 |
+
| Hugingface | [gradio lab webtool](https://github.com/gravelCompBio/Claspp_data_cur/tree/main) | webtool hosted on gradio lab (huggingface)|
|
| 114 |
+
| webtool | [website version of webtool](https://github.com/gravelCompBio/Claspp_data_cur/tree/main) | wettool hosted on a server|
|
| 115 |
+
|
| 116 |
+
- **Repository:** [More Information Needed]
|
| 117 |
+
- **Paper [optional]:** [More Information Needed]
|
| 118 |
+
- **Demo [optional]:** [More Information Needed]
|
| 119 |
+
|
| 120 |
+
## Uses
|
| 121 |
+
|
| 122 |
+
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
| 123 |
+
|
| 124 |
+
### Direct Use
|
| 125 |
+
|
| 126 |
+
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
| 127 |
+
|
| 128 |
+
[More Information Needed]
|
| 129 |
+
|
| 130 |
+
|
| 131 |
+
### Recommendations
|
| 132 |
+
|
| 133 |
+
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
| 134 |
+
|
| 135 |
+
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
| 136 |
+
|
| 137 |
+
## How to Get Started with the Model
|
| 138 |
+
|
| 139 |
|
| 140 |
### Downloading this repository
|
| 141 |
|
|
|
|
| 202 |
:tada: you are know ready to run the code :tada:
|
| 203 |
|
| 204 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 205 |
Use the code below to get started with the model.
|
| 206 |
|
| 207 |
[More Information Needed]
|
|
|
|
| 227 |
|
| 228 |
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
| 229 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 230 |
|
| 231 |
+
|
| 232 |
|
| 233 |
+
## Hardware
|
| 234 |
|
| 235 |
[More Information Needed]
|
| 236 |
|
|
|
|
| 237 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 238 |
|
| 239 |
## Citation [optional]
|
| 240 |
|
|
|
|
| 248 |
|
| 249 |
[More Information Needed]
|
| 250 |
|
|
|
|
| 251 |
|
|
|
|
| 252 |
|
|
|
|
| 253 |
|
|
|
|
|
|
|
|
|
|
| 254 |
|
|
|
|
| 255 |
|
| 256 |
+
- **Developed by:** [Nathan Gravel]
|
| 257 |
+
- **Funded by [optional]:** [NIH]
|
| 258 |
+
- **Shared by [optional]:** [More Information Neede]
|
| 259 |
+
- **Model type:** [Text classication]
|
| 260 |
+
- **Language(s) (NLP):** [Protein Sequence]
|
| 261 |
+
- **License:** [MIT]
|
| 262 |
+
- **Finetuned from model [optional]:** [ESM-2 150M]
|
| 263 |
|
| 264 |
[More Information Needed]
|