Skip to content

Commit

Permalink
docs: Update README with Docker usage instructions and dependency che…
Browse files Browse the repository at this point in the history
…ck output
  • Loading branch information
Ziaeemehr committed Feb 24, 2025
1 parent b1dbc08 commit a4b2ef2
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,33 @@
To use the Docker image, you can pull it from the GitHub Container Registry and run it as follows:

```bash
docker run --rm -it ghcr.io/ins-amu/vbi:main python3 -c 'from vbi.utils import test_imports; test_imports()'
docker build -t vbi-project . # build
docker run --gpus all -it vbi-project # use with gpu

# Output something like this:

Dependency Check

Package Version Status
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
vbi v0.1.3 ✅ Available
numpy 1.24.4 ✅ Available
scipy 1.10.1 ✅ Available
matplotlib 3.7.5 ✅ Available
sbi 0.22.0 ✅ Available
torch 2.4.1+cu121 ✅ Available
cupy 12.3.0 ✅ Available

Torch GPU available: True
Torch device count: 1
Torch CUDA version: 12.1
CuPy GPU available: True
CuPy device count: 1
CUDA Version: 11.8
Device Name: NVIDIA RTX A5000
Total Memory: 23.68 GB
Compute Capability: 8.6

```


Expand Down

0 comments on commit a4b2ef2

Please sign in to comment.