Update OFoldX model card metadata
Browse files
README.md
CHANGED
|
@@ -43,6 +43,15 @@ before using the artifact for scientific or operational decisions.
|
|
| 43 |
|
| 44 |
RFdiffusion backbone-generation model for protein design and motif scaffolding.
|
| 45 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 46 |
### Model Specification
|
| 47 |
|
| 48 |
| Field | Value |
|
|
@@ -54,10 +63,17 @@ RFdiffusion backbone-generation model for protein design and motif scaffolding.
|
|
| 54 |
| Entrypoint | `ofoldx.models.rfdiffusion.model.RfDiffusionDesignGenerator` |
|
| 55 |
| Config | `config.json` |
|
| 56 |
| Weights | `model.safetensors` |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 57 |
|
| 58 |
### Links
|
| 59 |
|
| 60 |
- **Hub repository**: [oteam/rfdiffusion-complex-base](https://huggingface.co/oteam/rfdiffusion-complex-base)
|
|
|
|
|
|
|
| 61 |
- **Code**: [`ofoldx/models/rfdiffusion/model.py`](https://github.com/OTeam-AI4S/OFoldX/tree/main/ofoldx/models/rfdiffusion/model.py)
|
| 62 |
- **Project repository**: [https://github.com/OTeam-AI4S/OFoldX](https://github.com/OTeam-AI4S/OFoldX)
|
| 63 |
- **Issues**: [https://github.com/OTeam-AI4S/OFoldX/issues](https://github.com/OTeam-AI4S/OFoldX/issues)
|
|
@@ -92,8 +108,16 @@ processed batch to the model.
|
|
| 92 |
|
| 93 |
## Training Details
|
| 94 |
|
| 95 |
-
|
| 96 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 97 |
|
| 98 |
## Evaluation
|
| 99 |
|
|
@@ -108,8 +132,20 @@ scientific evaluation should be checked against the corresponding upstream model
|
|
| 108 |
|
| 109 |
## Citation
|
| 110 |
|
| 111 |
-
Please cite the upstream
|
| 112 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 113 |
|
| 114 |
## Contact
|
| 115 |
|
|
@@ -117,5 +153,5 @@ Please use [OFoldX GitHub issues](https://github.com/OTeam-AI4S/OFoldX/issues) f
|
|
| 117 |
|
| 118 |
## License
|
| 119 |
|
| 120 |
-
The OFoldX project license is not yet finalized.
|
| 121 |
-
|
|
|
|
| 43 |
|
| 44 |
RFdiffusion backbone-generation model for protein design and motif scaffolding.
|
| 45 |
|
| 46 |
+
Converted RFdiffusion checkpoint for backbone generation, motif scaffolding, and binder design.
|
| 47 |
+
|
| 48 |
+
### Model Provenance
|
| 49 |
+
|
| 50 |
+
- **Upstream Project**: RFdiffusion
|
| 51 |
+
- **Source Checkpoint**: `Complex_base_ckpt.pt`
|
| 52 |
+
- **Primary Paper**: [De novo design of protein structure and function with RFdiffusion](https://doi.org/10.1038/s41586-023-06415-8)
|
| 53 |
+
- **Upstream License**: BSD for upstream RFdiffusion code and referenced model weights
|
| 54 |
+
|
| 55 |
### Model Specification
|
| 56 |
|
| 57 |
| Field | Value |
|
|
|
|
| 63 |
| Entrypoint | `ofoldx.models.rfdiffusion.model.RfDiffusionDesignGenerator` |
|
| 64 |
| Config | `config.json` |
|
| 65 |
| Weights | `model.safetensors` |
|
| 66 |
+
| Source Checkpoint | `Complex_base_ckpt.pt` |
|
| 67 |
+
| Checkpoint Variant | `Complex_base_ckpt` |
|
| 68 |
+
|
| 69 |
+
> [!NOTE]
|
| 70 |
+
> Source checkpoint: `Complex_base_ckpt.pt`.
|
| 71 |
|
| 72 |
### Links
|
| 73 |
|
| 74 |
- **Hub repository**: [oteam/rfdiffusion-complex-base](https://huggingface.co/oteam/rfdiffusion-complex-base)
|
| 75 |
+
- **Upstream paper**: [De novo design of protein structure and function with RFdiffusion](https://doi.org/10.1038/s41586-023-06415-8)
|
| 76 |
+
- **Upstream repository**: [RFdiffusion](https://github.com/RosettaCommons/RFdiffusion)
|
| 77 |
- **Code**: [`ofoldx/models/rfdiffusion/model.py`](https://github.com/OTeam-AI4S/OFoldX/tree/main/ofoldx/models/rfdiffusion/model.py)
|
| 78 |
- **Project repository**: [https://github.com/OTeam-AI4S/OFoldX](https://github.com/OTeam-AI4S/OFoldX)
|
| 79 |
- **Issues**: [https://github.com/OTeam-AI4S/OFoldX/issues](https://github.com/OTeam-AI4S/OFoldX/issues)
|
|
|
|
| 108 |
|
| 109 |
## Training Details
|
| 110 |
|
| 111 |
+
OFoldX did not train these weights. This repository contains a converted checkpoint and OFoldX runtime
|
| 112 |
+
metadata for loading it.
|
| 113 |
+
|
| 114 |
+
### Training Data
|
| 115 |
+
|
| 116 |
+
RFdiffusion training and use are described in the upstream Nature paper and repository. OFoldX does not redistribute the training set.
|
| 117 |
+
|
| 118 |
+
### Training Procedure
|
| 119 |
+
|
| 120 |
+
OFoldX converts released RFdiffusion checkpoints into `model.safetensors`; it does not run RFdiffusion training.
|
| 121 |
|
| 122 |
## Evaluation
|
| 123 |
|
|
|
|
| 132 |
|
| 133 |
## Citation
|
| 134 |
|
| 135 |
+
Please cite the upstream RFdiffusion work for the source checkpoint. If OFoldX supports your work, please also cite or link the OFoldX project repository.
|
| 136 |
+
|
| 137 |
+
```bibtex
|
| 138 |
+
@article{watson2023denovo,
|
| 139 |
+
author = {Watson, Joseph L. and Juergens, David and Bennett, Nathaniel R. and Trippe, Brian L. and Yim, Jason and Eisenach, Helen E. and Ahern, Woody and Borst, Andrew J. and Ragotte, Robert J. and Milles, Lukas F. and others},
|
| 140 |
+
title = {De novo design of protein structure and function with RFdiffusion},
|
| 141 |
+
journal = {Nature},
|
| 142 |
+
volume = {620},
|
| 143 |
+
number = {7976},
|
| 144 |
+
pages = {1089--1100},
|
| 145 |
+
year = {2023},
|
| 146 |
+
doi = {10.1038/s41586-023-06415-8}
|
| 147 |
+
}
|
| 148 |
+
```
|
| 149 |
|
| 150 |
## Contact
|
| 151 |
|
|
|
|
| 153 |
|
| 154 |
## License
|
| 155 |
|
| 156 |
+
The OFoldX project license is not yet finalized.
|
| 157 |
+
The source checkpoint is associated with the upstream license noted above: BSD for upstream RFdiffusion code and referenced model weights. Review both OFoldX and upstream terms before redistribution or production use.
|