Skip to content

Commit

Permalink
update readme to indicate compiled foldseek binary
Browse files Browse the repository at this point in the history
  • Loading branch information
endixk committed Feb 5, 2025
1 parent f730e3a commit ab0c43f
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,13 @@ unicore -v
```

### GPU acceleration with Foldseek-ProstT5
Foldseek provides a GPU-compatible static binary for ProstT5 prediction (requires Linux with AVX2 support, `glibc` ≥2.17, and `nvidia-driver` ≥525.60.13)<br>
To use it, please install it by running the following command:
```
wget https://mmseqs.com/foldseek/foldseek-linux-gpu.tar.gz; tar xvfz foldseek-linux-gpu.tar.gz; export PATH=$(pwd)/foldseek/bin/:$PATH
```
Then, add `--gpu` options to either `easy-core` or `createdb` module to use Foldseek implementation of ProstT5-GPU:
Foldseek features GPU-acceleration for ProstT5 prediction under following requirements:
* Turing or newer NVIDIA GPU
* `foldseek` ≥10
* `glibc` ≥2.17
* `nvidia-driver` ≥525.60.13

Apply `--gpu` option to either `easy-core` or `createdb` module to use it, e.g.
```
unicore easy-core --gpu <INPUT> <OUTPUT> <MODEL> <TMP>
```
Expand All @@ -52,7 +53,7 @@ unzip unicore_example.zip
If you cloned the repository, you can find the example dataset in the `example/data` folder.

### Download ProstT5 weights
You need to first download the ProstT5 weights to run the `createdb` module.
You can preliminarily download the ProstT5 weights required to run the `createdb` module.
```
foldseek databases ProstT5 weights tmp
```
Expand Down Expand Up @@ -133,8 +134,6 @@ This module runs much faster with GPU. Please install `cuda` for GPU acceleratio

To run the module, please use the following command:
```
// Download ProstT5 weights as below if you haven't already
// foldseek databases ProstT5 /path/to/prostt5/weights tmp
unicore createdb data db/proteome_db /path/to/prostt5/weights
```
This will create a Foldseek database in the `db` folder.
Expand Down Expand Up @@ -211,7 +210,7 @@ unicore gene-tree --realign --threshold 30 --name /path/to/hashed/gene/names tre
## Build from Source
### Minimum requirements
* [Cargo](https://www.rust-lang.org/tools/install) (Rust)
* [Foldseek](https://foldseek.com) (version ≥ 9)
* [Foldseek](https://foldseek.com) (version ≥ 10)
* [Foldmason](https://foldmason.foldseek.com)
* [IQ-TREE](http://www.iqtree.org/)
### Optional requirements
Expand All @@ -232,5 +231,5 @@ With these tools installed, you can install and run `unicore` by:
git clone https://github.com/steineggerlab/unicore.git
cd unicore
cargo build --release
bin/unicore help
bin/unicore -v
```

0 comments on commit ab0c43f

Please sign in to comment.