README.md 1.48 KB
Newer Older
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
1
2
3
4
5
6
7
# OpenFold

A faithful PyTorch reproduction of DeepMind's 
[AlphaFold 2](https://github.com/deepmind/alphafold).

## Installation

Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
8
9
10
Python dependencies available through `pip` are provided in `requirements.txt`. 
OpenFold also depends on `openmm==7.5.1` and `pdbfixer`, which are only
available via `conda`. 
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
11

Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
12
For convenience, we provide a script that installs Miniconda locally, creates a 
13
14
`conda` virtual environment, installs all Python dependencies, and downloads
useful resources (including DeepMind's pretrained parameters). Run:
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
15
16

```bash
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
17
18
19
scripts/install_third_party_dependencies.sh
```

Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
20
To activate the environment, run:
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
21
22

```bash
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
23
source scripts/activate_conda_venv.sh
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
24
25
```

26
To deactivate it, run:
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
27
28

```bash
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
29
source scripts/deactivate_conda_venv.sh
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
30
31
32
33
```

## Features

34
35
36
37
OpenFold supports all features of the original AlphaFold required for inference
with the sole exception of model ensembling, which fared poorly in DeepMind's 
ablation testing. It is even capable of importing AlphaFold's original 
pretrained model parameters. 
Gustaf Ahdritz's avatar
Gustaf Ahdritz committed
38
39
40

Future versions will support multi-GPU training with 
[DeepSpeed](https://github.com/microsoft/DeepSpeed).
41
42
43
44
45
46
47
48

## Copyright notice

While AlphaFold's and, by extension, OpenFold's source code is licensed under
the permissive Apache Licence, Version 2.0, DeepMind's pretrained parameters 
remain under the more restrictive CC BY-NC 4.0 license, a copy of which is 
downloaded to `openfold/resources/params` by the installation script. They are
thereby made unavailable for commercial use.