Skip to content

Commit 459e5f4

Browse files
committed
Update REAMDE MDs
1 parent fc194b5 commit 459e5f4

File tree

2 files changed

+13
-5
lines changed

2 files changed

+13
-5
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
## Table of Contents
22
[PyPEF: Pythonic Protein Engineering Framework](#pypef-pythonic-protein-engineering-framework)
33
- [Quick Installation](#quick-installation)
4+
- [Setup and Run Docker Image](#setup-and-run-docker-image)
45
- [GUI Installation](#gui-installation)
56
- [Requirements](#requirements)
67
- [Running Examples](#running-examples)
@@ -67,15 +68,17 @@ pypef --help
6768
The detailed routine for setting up a new virtual environment with Anaconda, installing the necessary Python packages for that environment, and running the Jupyter notebook tutorial can be found below in the Tutorial section.
6869
A quick file setup and run test can be performed running files in [scripts/Setup](scripts/Setup) containing a Batch script for Windows and a Bash script for Linux (the latter requires conda, i.e. Miniconda3 or Anaconda3, already being installed).
6970

70-
### Setup and Run Docker Image
71+
72+
<a name="docker-installation"></a>
73+
### Setup and Run Docker Image
7174

7275
Build the image using the stored [Dockerfile](./Dockerfile)
7376
```bash
7477
docker build -t pypef . # --progress=plain --no-cache
7578
```
7679

7780
A chained container command using the built Docker image can be run with e.g.:
78-
```
81+
```bash
7982
docker run --gpus=all -v ./datasets/:/datasets --workdir /datasets/AVGFP pypef /bin/bash -c \
8083
"python /app/run.py mklsts --wt P42212_F64L.fasta --input avGFP.csv --ls_proportion 0.01 && \
8184
python /app/run.py hybrid --ls LS.fasl --ts TS.fasl --params GREMLIN --llm prosst --wt P42212_F64L.fasta --pdb GFP_AEQVI.pdb"

scripts/ProteinGym_runs/README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
## Benchmark runs on publicly available ProteinGym protein variant sequence-fitness datasets
22

3-
Data is taken (script-based download) from "DMS Assays"-->"Substitutions" and "Multiple Sequence Alignments"-->"DMS Assays" data from https://proteingym.org/download.
4-
Run the following to download and extract the ProteinGym data and subsequently to get the predictions/the performance on those datasets.
5-
Based on available GPU/VRAM, variable `MAX_WT_SEQUENCE_LENGTH` in script [run_performance_tests_proteingym_hybrid_dca_llm.py](run_performance_tests_proteingym_hybrid_dca_llm.py) has to adjusted according to available (V)RAM. E.g., results ([results/dca_esm_and_hybrid_opt_results.csv](results/dca_esm_and_hybrid_opt_results.csv), graphically presented on the main page README) were computed with an NVIDIA GeForce RTX 5090 with 32 GB VRAM and setting `MAX_WT_SEQUENCE_LENGTH` to 1000 (GPU power limit set to 520 W):
3+
Data is taken (script-based download) from
4+
5+
"DMS Assays"-->"Substitutions" and "Multiple Sequence Alignments"-->"DMS Assays" data
6+
7+
from https://proteingym.org/download.
8+
9+
Perform the following steps to download and extract the ProteinGym data and then obtain the predictions/performance for these datasets.
10+
Depending on the available GPU/VRAM, the variable `MAX_WT_SEQUENCE_LENGTH` in the script [run_performance_tests_proteingym_hybrid_dca_llm.py](run_performance_tests_proteingym_hybrid_dca_llm.py) must be adjusted according to the available (V)RAM. For example, the results ([results/dca_esm_and_hybrid_opt_results.csv](results/dca_esm_and_hybrid_opt_results.csv), shown graphically on the main README page) were calculated with an NVIDIA GeForce RTX 5090 with 32 GB VRAM and the setting `MAX_WT_SEQUENCE_LENGTH = 1000` (GPU power limit set to 520 W):
611

712
```sh
813
#python -m pip install -r ../../requirements.txt

0 commit comments

Comments
 (0)