Commit a3a27143 authored by Gustaf Ahdritz's avatar Gustaf Ahdritz
Browse files

Add testing instructions to README

parent aea444ed
...@@ -69,6 +69,26 @@ python3 run_pretrained_openfold.py --help ...@@ -69,6 +69,26 @@ python3 run_pretrained_openfold.py --help
for a full list of options. for a full list of options.
## Testing
To run unit tests, use
```bash
scripts/run_unit_tests.sh
```
The script is a thin wrapper around Python's `unittest` suite, and recognizes
`unittest` commands. E.g., to run a specific test verbosely:
```bash
scripts/run_unit_tests.sh -v tests.test_model
```
Certain tests require that AlphaFold be installed in the same Python
environment. These run components of AlphaFold and OpenFold side by side and
ensure that output activations are adequately similar. For most modules, we
target a maximum difference of 1e-4.
## Copyright notice ## Copyright notice
While AlphaFold's and, by extension, OpenFold's source code is licensed under While AlphaFold's and, by extension, OpenFold's source code is licensed under
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment