eugeneyuan commited on
Commit
6bb1e1a
·
verified ·
1 Parent(s): 0ef798b

docs: update README

Browse files
Files changed (1) hide show
  1. README.md +35 -1
README.md CHANGED
@@ -12,8 +12,10 @@ tags:
12
 
13
  <div align="center">
14
 
 
15
  [![GitHub](https://img.shields.io/badge/GitHub-cryofm-181717?logo=github&logoColor=white)](https://github.com/ByteDance-Seed/cryofm)
16
  [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
17
 
18
  </div>
19
 
@@ -66,6 +68,23 @@ CryoFM2 is pretrained on curated EMDB half maps to learn general priors of high-
66
 
67
  ## Play with CryoFM2
68
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
69
  ### Unconditional Generation (Explore Training Data Distribution)
70
 
71
  Generate samples from the pretrained model to explore the learned data distribution:
@@ -255,7 +274,22 @@ This model is intended for scientific research and structural biology applicatio
255
 
256
  ## Citation
257
 
258
- TBA
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
259
 
260
  ## License
261
 
 
12
 
13
  <div align="center">
14
 
15
+ [![Tech Report](https://img.shields.io/badge/Tech%20Report-bioRxiv-0066CC?logo=doi&logoColor=white)](https://doi.org/10.64898/2025.12.29.696802)
16
  [![GitHub](https://img.shields.io/badge/GitHub-cryofm-181717?logo=github&logoColor=white)](https://github.com/ByteDance-Seed/cryofm)
17
  [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
18
+ [![Docs](https://img.shields.io/badge/Docs-cryofm-4CAF50?logo=read-the-docs&logoColor=white)](https://bytedance-seed.github.io/cryofm/docs/)
19
 
20
  </div>
21
 
 
68
 
69
  ## Play with CryoFM2
70
 
71
+ ### Installation
72
+
73
+ Before using CryoFM2, you need to set up the environment and install the package. Follow these steps to get started:
74
+
75
+ ```bash
76
+ # Clone the repository
77
+ git clone https://github.com/ByteDance-Seed/cryofm.git
78
+ cd cryofm
79
+
80
+ # Create a new conda environment for CryoFM (recommended)
81
+ conda create -n cryofm python=3.10 -y
82
+ conda activate cryofm
83
+
84
+ # Install CryoFM
85
+ pip install .
86
+ ```
87
+
88
  ### Unconditional Generation (Explore Training Data Distribution)
89
 
90
  Generate samples from the pretrained model to explore the learned data distribution:
 
274
 
275
  ## Citation
276
 
277
+ If you find CryoFM2 useful, please cite:
278
+
279
+ ```bibtex
280
+ @article{
281
+ Li2025.12.29.696802,
282
+ author={Li, Yilai and Yuan, Jing and Zhou, Yi and Wang, Zhenghua and Chen, Suyi and Yang, Fengyu and Ling, Haibin and Kovalsky, Shahar Z and Zheng, Xiaoqing and Gu, Quanquan},
283
+ title={A Generative Foundation Model for Cryo-EM Densities},
284
+ elocation-id={2025.12.29.696802},
285
+ year={2025},
286
+ doi={10.64898/2025.12.29.696802},
287
+ publisher={Cold Spring Harbor Laboratory},
288
+ URL={https://www.biorxiv.org/content/early/2025/12/29/2025.12.29.696802},
289
+ eprint={https://www.biorxiv.org/content/early/2025/12/29/2025.12.29.696802.full.pdf},
290
+ journal={bioRxiv}
291
+ }
292
+ ```
293
 
294
  ## License
295