docs: update README
Browse files
README.md
CHANGED
|
@@ -14,6 +14,7 @@ tags:
|
|
| 14 |
[](https://arxiv.org/abs/2410.08631)
|
| 15 |
[](https://github.com/ByteDance-Seed/cryofm)
|
| 16 |
[](https://opensource.org/licenses/Apache-2.0)
|
|
|
|
| 17 |
|
| 18 |
</div>
|
| 19 |
|
|
@@ -60,6 +61,36 @@ The model is available in two variants optimized for different resolution requir
|
|
| 60 |
|
| 61 |
## Quick Start
|
| 62 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 63 |
### Unconditional Generation
|
| 64 |
|
| 65 |
CryoFM1 provides two model variants for different resolution needs:
|
|
@@ -132,7 +163,12 @@ for i in range(3):
|
|
| 132 |
)
|
| 133 |
```
|
| 134 |
|
| 135 |
-
###
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 136 |
|
| 137 |
This model is intended for scientific research and structural biology applications. Users should:
|
| 138 |
- Ensure proper attribution when using generated structures
|
|
|
|
| 14 |
[](https://arxiv.org/abs/2410.08631)
|
| 15 |
[](https://github.com/ByteDance-Seed/cryofm)
|
| 16 |
[](https://opensource.org/licenses/Apache-2.0)
|
| 17 |
+
[](https://bytedance-seed.github.io/cryofm/docs/)
|
| 18 |
|
| 19 |
</div>
|
| 20 |
|
|
|
|
| 61 |
|
| 62 |
## Quick Start
|
| 63 |
|
| 64 |
+
### Installation
|
| 65 |
+
|
| 66 |
+
Before using CryoFM1, ensure you have:
|
| 67 |
+
|
| 68 |
+
#### 1. Install CryoFM with compatible dependencies
|
| 69 |
+
|
| 70 |
+
CryoFM1 uses the HDiT model architecture, which depends on the `natten` package. Different versions of `natten` have varying requirements for PyTorch and CUDA versions. For a reproducible installation, follow these steps:
|
| 71 |
+
|
| 72 |
+
```bash
|
| 73 |
+
# natten 0.17.5 uses type union syntax, you must use python >=3.10
|
| 74 |
+
conda create -n cryofm python=3.10 -y
|
| 75 |
+
conda activate cryofm
|
| 76 |
+
|
| 77 |
+
# Install PyTorch 2.5.1 with CUDA 12.4 support
|
| 78 |
+
pip install torch==2.5.1 torchvision==0.20.1 --index-url https://download.pytorch.org/whl/cu124
|
| 79 |
+
|
| 80 |
+
# Install natten 0.17.5 compatible with PyTorch 2.5.0 and CUDA 12.4
|
| 81 |
+
pip install natten==0.17.5+torch250cu124 -f https://whl.natten.org
|
| 82 |
+
|
| 83 |
+
# Clone and install CryoFM
|
| 84 |
+
git clone https://github.com/ByteDance-Seed/cryofm
|
| 85 |
+
cd cryofm
|
| 86 |
+
pip install .
|
| 87 |
+
```
|
| 88 |
+
|
| 89 |
+
#### 2. Download model checkpoints and configuration files
|
| 90 |
+
|
| 91 |
+
Download the CryoFM1 model weights and configuration files from the [Hugging Face repository](https://huggingface.co/ByteDance-Seed/cryofm-v1).
|
| 92 |
+
|
| 93 |
+
|
| 94 |
### Unconditional Generation
|
| 95 |
|
| 96 |
CryoFM1 provides two model variants for different resolution needs:
|
|
|
|
| 163 |
)
|
| 164 |
```
|
| 165 |
|
| 166 |
+
### Downstream Tasks
|
| 167 |
+
|
| 168 |
+
CryoFM1 demonstrates various downstream tasks including density map denoising, anisotropy noise correction, and missing wedge restoration. For detailed instructions on how to run these tasks, please refer to the [Downstream Tasks documentation](https://bytedance-seed.github.io/cryofm/docs/model-guides/cryofm1/downstream-tasks.html).
|
| 169 |
+
|
| 170 |
+
|
| 171 |
+
## Ethical Considerations
|
| 172 |
|
| 173 |
This model is intended for scientific research and structural biology applications. Users should:
|
| 174 |
- Ensure proper attribution when using generated structures
|