Skip to content

Commit ef50fba

Browse files
committed
Adjust structure of README to reflect standard format across the repo (see template README)
1 parent 3082709 commit ef50fba

1 file changed

Lines changed: 57 additions & 20 deletions

File tree

ollama/README.md

Lines changed: 57 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,22 @@
11
# Ollama
22

3-
Docker image bundling [Ollama](https://ollama.com/) with the [Sprocket](https://github.com/stjude-rust-labs/sprocket) WDL validator, designed for benchmarking LLM-generated WDL scripts.
3+
This directory contains Docker images for [Ollama](https://ollama.com/), an LLM inference server, bundled with the [Sprocket](https://github.com/stjude-rust-labs/sprocket) WDL validator and the [Python ollama SDK](https://pypi.org/project/ollama/). Designed for benchmarking LLM-generated WDL scripts.
44

55
## Available Versions
66

7-
| Tag | Ollama Version | Sprocket Version | Python ollama SDK |
8-
|-----|---------------|-----------------|-------------------|
9-
| latest | 0.21.0 | 0.23.0 | 0.6.1 |
10-
| 0.21.0 | 0.21.0 | 0.23.0 | 0.6.1 |
7+
- `latest` ( [Dockerfile](https://github.com/getwilds/wilds-docker-library/blob/main/ollama/Dockerfile_latest) | [Vulnerability Report](https://github.com/getwilds/wilds-docker-library/blob/main/ollama/CVEs_latest.md) )
8+
- `0.21.0` ( [Dockerfile](https://github.com/getwilds/wilds-docker-library/blob/main/ollama/Dockerfile_0.21.0) | [Vulnerability Report](https://github.com/getwilds/wilds-docker-library/blob/main/ollama/CVEs_0.21.0.md) )
9+
10+
## Image Details
11+
12+
These Docker images are built from `ollama/ollama:0.21.0` and include:
13+
14+
- Ollama v0.21.0: LLM inference server for running models locally
15+
- Sprocket v0.23.0: WDL script validator (compiled from source via cargo)
16+
- Python ollama SDK v0.6.1: Python client library for interacting with Ollama
17+
- Python 3 (system version from base image)
18+
19+
Note: Sprocket is compiled from source during the Docker build using Rust's `cargo install`. The Rust toolchain is removed after compilation to minimize image size.
1120

1221
## Platform Availability
1322

@@ -17,25 +26,48 @@ Sprocket is compiled from source during the Docker build, which causes arm64 bui
1726

1827
A GPU is not required to run this image, but is highly encouraged — CPU-only execution of LLMs is significantly slower.
1928

29+
## Citation
30+
31+
This image bundles two independent tools. If you use them in your research, please cite the original authors:
32+
33+
- **Ollama** (LLM inference server): https://ollama.com/
34+
- **Sprocket** (WDL execution engine): https://github.com/stjude-rust-labs/sprocket
35+
2036
## Usage
2137

2238
### Docker
2339

2440
```bash
41+
# Pull the latest version
2542
docker pull getwilds/ollama:latest
26-
docker run --rm getwilds/ollama:latest ollama --version
43+
44+
# Or pull a specific version
45+
docker pull getwilds/ollama:0.21.0
46+
47+
# Alternatively, pull from GitHub Container Registry
48+
docker pull ghcr.io/getwilds/ollama:latest
2749
```
2850

29-
### Apptainer/Singularity
51+
### Singularity/Apptainer
3052

3153
```bash
54+
# Pull the latest version
3255
apptainer pull docker://getwilds/ollama:latest
33-
apptainer run ollama_latest.sif ollama --version
56+
57+
# Or pull a specific version
58+
apptainer pull docker://getwilds/ollama:0.21.0
59+
60+
# Alternatively, pull from GitHub Container Registry
61+
apptainer pull docker://ghcr.io/getwilds/ollama:latest
3462
```
3563

36-
### Example: Run a Model and Validate WDL Output
64+
### Example Commands
3765

3866
```bash
67+
# Check installed versions
68+
docker run --rm getwilds/ollama:latest ollama --version
69+
docker run --rm getwilds/ollama:latest sprocket --version
70+
3971
# Start the container with GPU access
4072
docker run --rm --gpus all -it getwilds/ollama:latest
4173

@@ -57,20 +89,25 @@ with open('/tmp/output.wdl', 'w') as f:
5789
sprocket lint /tmp/output.wdl
5890
```
5991

60-
## Installed Components
92+
## Dockerfile Structure
6193

62-
- Ollama: v0.21.0 (LLM inference server)
63-
- Sprocket: v0.23.0 (WDL script validator, compiled from source via cargo)
64-
- Python ollama SDK: v0.6.1
65-
- Python 3 (system version from base image)
94+
The Dockerfile follows these main steps:
6695

67-
Note: Sprocket is compiled from source during the Docker build using Rust's `cargo install`. The Rust toolchain is removed after compilation to minimize image size.
96+
1. Uses `ollama/ollama:0.21.0` as the base image
97+
2. Adds metadata labels for documentation and attribution
98+
3. Installs system dependencies with pinned versions (Python, curl, build tools)
99+
4. Installs the Python ollama SDK via pip
100+
5. Installs Rust via rustup, compiles Sprocket from source, then removes the Rust toolchain
101+
6. Runs smoke tests to verify all tools are installed correctly
102+
103+
## Security Scanning and CVEs
104+
105+
These images are regularly scanned for vulnerabilities using Docker Scout. However, due to the nature of bioinformatics software and their dependencies, some Docker images may contain components with known vulnerabilities (CVEs).
68106

69-
## Security
107+
**Use at your own risk**: While we strive to minimize security issues, these images are primarily designed for research and analytical workflows in controlled environments.
70108

71-
Vulnerability reports are available in this directory as `CVEs_*.md` files.
72-
Images are scanned monthly and on each build.
109+
For the latest security information about this image, please check the `CVEs_*.md` files in [this directory](https://github.com/getwilds/wilds-docker-library/blob/main/ollama), which are automatically updated through our GitHub Actions workflow. If a particular vulnerability is of concern, please file an [issue](https://github.com/getwilds/wilds-docker-library/issues) in the GitHub repo citing which CVE you would like to be addressed.
73110

74-
## Contributing
111+
## Source Repository
75112

76-
See the [CONTRIBUTING.md](../.github/CONTRIBUTING.md) for guidelines.
113+
These Dockerfiles are maintained in the [WILDS Docker Library](https://github.com/getwilds/wilds-docker-library) repository.

0 commit comments

Comments
 (0)