tigerflow-ml
ML tasks for TigerFlow — private cloud ML APIs on HPC infrastructure.
Installation
pip install tigerflow-ml
If using a task that relies on vllm (chat, OCR, or translation), install with:
pip install tigerflow-ml[vllm]
Tasks
| Task | Description | Entry Point |
|---|---|---|
| OCR | Extract text from images and PDFs | ocr / ocr-local |
| Translation | Translate text documents | translate / translate-local |
| Chat | Apply a chat prompt to images or text | chat / chat-local |
| Transcription | Transcribe audio to text | transcribe / transcribe-local |
| Object Detection | Detect objects in images and videos | detect / detect-local |
Each task provides both a Slurm variant (for HPC) and a Local variant (for development).
Usage
After installation, tasks are automatically discoverable via:
tigerflow tasks list
Run a task directly:
python -m tigerflow_ml.text.ocr.slurm --help
python -m tigerflow_ml.text.translate.slurm --help
python -m tigerflow_ml.text.chat.slurm --help
python -m tigerflow_ml.audio.transcribe.slurm --help
python -m tigerflow_ml.image.detect.slurm --help
Container
A GPU image with all tasks (including the vllm extra) is published to GHCR on
each release:
docker pull ghcr.io/princeton-ddss/tigerflow-ml:latest
The image bundles its own CUDA libraries, so only the host NVIDIA driver is
needed at runtime — pass --gpus all (Docker) or --nv (Apptainer). Models are
fetched on first use; mount a cache at /cache to persist them.
The entrypoint is tigerflow, so arguments are passed straight to the CLI:
# Run a pipeline (config file + input/output directories)
docker run --gpus all -v "$PWD/cache:/cache" -v "$PWD:/data" \
ghcr.io/princeton-ddss/tigerflow-ml:latest \
run /data/pipeline.yaml /data/input /data/output
# List available tasks
docker run ghcr.io/princeton-ddss/tigerflow-ml:latest tasks list
# Run a single task module directly (override the entrypoint)
docker run --gpus all -v "$PWD/cache:/cache" -v "$PWD:/data" \
--entrypoint python ghcr.io/princeton-ddss/tigerflow-ml:latest \
-m tigerflow_ml.audio.transcribe.local --help
On HPC, convert to a Singularity/Apptainer image:
apptainer build tigerflow-ml.sif docker://ghcr.io/princeton-ddss/tigerflow-ml:latest
apptainer run --nv -B ./cache:/cache tigerflow-ml.sif run pipeline.yaml input output
apptainer exec --nv tigerflow-ml.sif python -m tigerflow_ml.audio.transcribe.local --help
Development
uv sync --group dev
uv run pre-commit run --all-files
uv run pytest tests
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file tigerflow_ml-0.1.0.tar.gz.
File metadata
- Download URL: tigerflow_ml-0.1.0.tar.gz
- Upload date:
- Size: 3.0 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d7eeb4b7ed318a2aa4a570440dff36999fd87ac673db5034980844c1a0de7d74
|
|
| MD5 |
d6042bd68f053ad4a7c7c5fc062df88a
|
|
| BLAKE2b-256 |
0b0d2e76104a966adc1abd2fd5c0d3213c71dd41053de40c93ed8c0c62ce6a9d
|
Provenance
The following attestation bundles were made for tigerflow_ml-0.1.0.tar.gz:
Publisher:
cd.yml on princeton-ddss/tigerflow-ml
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
tigerflow_ml-0.1.0.tar.gz -
Subject digest:
d7eeb4b7ed318a2aa4a570440dff36999fd87ac673db5034980844c1a0de7d74 - Sigstore transparency entry: 1969415970
- Sigstore integration time:
-
Permalink:
princeton-ddss/tigerflow-ml@f66a72764bc7d07d87a84bae0489c52b4934a091 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/princeton-ddss
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
cd.yml@f66a72764bc7d07d87a84bae0489c52b4934a091 -
Trigger Event:
release
-
Statement type:
File details
Details for the file tigerflow_ml-0.1.0-py3-none-any.whl.
File metadata
- Download URL: tigerflow_ml-0.1.0-py3-none-any.whl
- Upload date:
- Size: 51.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f55a55136e7d8d4849752e62e7a770a3e291b42a316fe8e6e098497c02223b8a
|
|
| MD5 |
0428f0eb9424846c5311374669043627
|
|
| BLAKE2b-256 |
69042ea3011764d7c525251e35cdd4131d5ec2c58ed0060dac39c906ee453602
|
Provenance
The following attestation bundles were made for tigerflow_ml-0.1.0-py3-none-any.whl:
Publisher:
cd.yml on princeton-ddss/tigerflow-ml
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
tigerflow_ml-0.1.0-py3-none-any.whl -
Subject digest:
f55a55136e7d8d4849752e62e7a770a3e291b42a316fe8e6e098497c02223b8a - Sigstore transparency entry: 1969416033
- Sigstore integration time:
-
Permalink:
princeton-ddss/tigerflow-ml@f66a72764bc7d07d87a84bae0489c52b4934a091 -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/princeton-ddss
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
cd.yml@f66a72764bc7d07d87a84bae0489c52b4934a091 -
Trigger Event:
release
-
Statement type:
