README.md 2.94 KB
Newer Older
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
1
![header ](imgs/of_banner.png)
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
2
_Figure: Comparison of OpenFold and AlphaFold2 predictions to the experimental structure of PDB 7KDX, chain B._
3

Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
4
5
# OpenFold

Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
6
A faithful but trainable PyTorch reproduction of DeepMind's 
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
7
8
[AlphaFold 2](https://github.com/deepmind/alphafold).

jnwei's avatar
jnwei committed
9
10
# Documentation
See our new home for docs at [openfold.readthedocs.io](https://openfold.readthedocs.io/en/latest/), with instructions for installation and model inference/training.
11

12
13
Much of the content from this page may be found [here.](https://github.com/aqlaboratory/openfold/blob/main/docs/source/original_readme.md)

jnwei's avatar
jnwei committed
14
## Copyright Notice
15
16
17

While AlphaFold's and, by extension, OpenFold's source code is licensed under
the permissive Apache Licence, Version 2.0, DeepMind's pretrained parameters 
18
19
fall under the CC BY 4.0 license, a copy of which is downloaded to 
`openfold/resources/params` by the installation script. Note that the latter
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
20
replaces the original, more restrictive CC BY-NC 4.0 license as of January 2022.
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
21
22
23

## Contributing

Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
24
25
If you encounter problems using OpenFold, feel free to create an issue! We also
welcome pull requests from the community.
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
26

jnwei's avatar
jnwei committed
27
## Citing this Work
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
28

Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
29
Please cite our paper:
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
30

Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
31
```bibtex
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
32
@article {Ahdritz2022.11.20.517210,
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
33
	author = {Ahdritz, Gustaf and Bouatta, Nazim and Floristean, Christina and Kadyan, Sachin and Xia, Qinghui and Gerecke, William and O{\textquoteright}Donnell, Timothy J and Berenberg, Daniel and Fisk, Ian and Zanichelli, Niccolò and Zhang, Bo and Nowaczynski, Arkadiusz and Wang, Bei and Stepniewska-Dziubinska, Marta M and Zhang, Shang and Ojewole, Adegoke and Guney, Murat Efe and Biderman, Stella and Watkins, Andrew M and Ra, Stephen and Lorenzo, Pablo Ribalta and Nivon, Lucas and Weitzner, Brian and Ban, Yih-En Andrew and Sorger, Peter K and Mostaque, Emad and Zhang, Zhao and Bonneau, Richard and AlQuraishi, Mohammed},
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
34
	title = {{O}pen{F}old: {R}etraining {A}lpha{F}old2 yields new insights into its learning mechanisms and capacity for generalization},
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
35
36
37
38
	elocation-id = {2022.11.20.517210},
	year = {2022},
	doi = {10.1101/2022.11.20.517210},
	publisher = {Cold Spring Harbor Laboratory},
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
39
	URL = {https://www.biorxiv.org/content/10.1101/2022.11.20.517210},
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
40
41
	eprint = {https://www.biorxiv.org/content/early/2022/11/22/2022.11.20.517210.full.pdf},
	journal = {bioRxiv}
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
42
43
}
```
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
44
If you use OpenProteinSet, please also cite:
Gustaf Ahdritz's avatar
Add DOI  
Gustaf Ahdritz committed
45

Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
46
47
48
49
50
51
52
53
54
55
```bibtex
@misc{ahdritz2023openproteinset,
      title={{O}pen{P}rotein{S}et: {T}raining data for structural biology at scale}, 
      author={Gustaf Ahdritz and Nazim Bouatta and Sachin Kadyan and Lukas Jarosch and Daniel Berenberg and Ian Fisk and Andrew M. Watkins and Stephen Ra and Richard Bonneau and Mohammed AlQuraishi},
      year={2023},
      eprint={2308.05326},
      archivePrefix={arXiv},
      primaryClass={q-bio.BM}
}
```
Jennifer's avatar
Jennifer committed
56
Any work that cites OpenFold should also cite [AlphaFold](https://www.nature.com/articles/s41586-021-03819-2) and [AlphaFold-Multimer](https://www.biorxiv.org/content/10.1101/2021.10.04.463034v1) if applicable.