tigerflow-ml 0.1.0a0__tar.gz

tigerflow_ml-0.1.0a0/.github/workflows/cd.yml

@@ -0,0 +1,84 @@
+name: CD
+
+on:
+  release:
+    types: [published]
+
+env:
+  UV_VERSION: "0.7.15"
+
+permissions:
+  contents: write
+
+jobs:
+  ci:
+    uses: ./.github/workflows/ci.yml
+
+  publish:
+    needs: ci
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Configure Git credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+
+      - name: Install uv and set up Python
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: ${{ env.UV_VERSION }}
+          enable-cache: true
+          python-version-file: ".python-version"
+
+      - name: Sync version with tag name
+        run: |
+          VERSION=$(echo "${{ github.event.release.tag_name }}" | sed 's/^v//')
+          uv version $VERSION
+          git add .
+          git commit -m "Update package version" || echo "Package version up to date"
+          git push origin HEAD:main
+
+      - name: Build the package
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  docs:
+    needs: publish
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Configure Git credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+
+      - name: Checkout merge branch
+        run: |
+          git fetch origin
+          git checkout ${{ github.ref_name }}
+
+      - name: Install uv and set up Python
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: ${{ env.UV_VERSION }}
+          enable-cache: true
+          python-version-file: ".python-version"
+
+      - name: Install dependencies
+        run: uv sync --locked --group docs
+
+      - name: Publish docs to gh-pages
+        run: |
+          cd docs
+          MINOR_VERSION=$(echo "${{ github.event.release.tag_name }}" | sed 's/^v\?\([0-9]*\.[0-9]*\).*/\1/')
+          uv run mike deploy --push --update-aliases $MINOR_VERSION latest
+          uv run mike set-default --push latest

tigerflow_ml-0.1.0a0/.github/workflows/ci.yml

@@ -0,0 +1,122 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_call:
+
+concurrency:
+  group: CI-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  UV_VERSION: "0.7.15"
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv and set up Python
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: ${{ env.UV_VERSION }}
+          enable-cache: true
+          cache-dependency-glob: |
+            uv.lock
+            pyproject.toml
+          python-version-file: ".python-version"
+
+      - name: Install dependencies
+        run: uv sync --locked --group lint
+
+      - name: Run pre-commit
+        run: uv run pre-commit run --all-files
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv and set up Python
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: ${{ env.UV_VERSION }}
+          enable-cache: true
+          cache-dependency-glob: |
+            uv.lock
+            pyproject.toml
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --locked --group test
+
+      - name: Run tests
+        run: uv run pytest tests
+
+  build:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv and set up Python
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: ${{ env.UV_VERSION }}
+          enable-cache: true
+          cache-dependency-glob: |
+            uv.lock
+            pyproject.toml
+          python-version-file: ".python-version"
+
+      - name: Build the package
+        run: uv build
+
+  docs:
+    needs: test
+    if: github.event_name == 'push'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Configure Git credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+
+      - name: Install uv and set up Python
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: ${{ env.UV_VERSION }}
+          enable-cache: true
+          cache-dependency-glob: |
+            uv.lock
+            pyproject.toml
+          python-version-file: ".python-version"
+
+      - name: Install dependencies
+        run: uv sync --locked --group docs
+
+      - name: Fetch gh-pages branch
+        run: git fetch origin gh-pages --depth=1
+
+      - name: Publish docs to gh-pages
+        run: |
+          cd docs
+          uv run mike deploy --push next
+          uv run mike set-default --push next

tigerflow_ml-0.1.0a0/.gitignore

@@ -0,0 +1,38 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.eggs/
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Type checking
+.ty/
+.mypy_cache/
+
+# OS
+.DS_Store
+Thumbs.db
+
+# mkdocs
+site/
+
+# Examples (generated test data)
+examples/*/.cache/
+examples/*/input/
+examples/*/output/

tigerflow_ml-0.1.0a0/.pre-commit-config.yaml

@@ -0,0 +1,43 @@
+ci:
+  autoupdate_commit_msg: "chore: update pre-commit hooks"
+  autoupdate_schedule: weekly
+  autofix_commit_msg: "style: pre-commit fixes"
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-yaml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+      - id: codespell
+        args: [-L, als]
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.10.0
+    hooks:
+      - id: python-use-type-annotations
+      - id: python-no-log-warn
+      - id: python-check-mock-methods
+      - id: python-no-eval
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.0
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+  - repo: local
+    hooks:
+      - id: ty
+        name: ty check
+        entry: uvx ty check .
+        language: system
+        pass_filenames: false
+        always_run: true

tigerflow_ml-0.1.0a0/.python-version

@@ -0,0 +1 @@
+3.10

tigerflow_ml-0.1.0a0/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2025-2026 Colin Swaney, Sangyoon Park, The Trustees of Princeton University
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

tigerflow_ml-0.1.0a0/PKG-INFO

@@ -0,0 +1,79 @@
+Metadata-Version: 2.4
+Name: tigerflow-ml
+Version: 0.1.0a0
+Summary: ML task library for TigerFlow
+Project-URL: Repository, https://github.com/princeton-ddss/tigerflow-ml
+Project-URL: Documentation, https://princeton-ddss.github.io/tigerflow-ml/latest
+Author-email: Colin Swaney <colinswaney@princeton.edu>, Sangyoon Park <sp8538@princeton.edu>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Image Recognition
+Classifier: Topic :: Text Processing :: Linguistic
+Requires-Python: <3.14,>=3.10
+Requires-Dist: opencv-python-headless
+Requires-Dist: pillow
+Requires-Dist: pymupdf>=1.27.1
+Requires-Dist: sentencepiece
+Requires-Dist: tigerflow>=0.1.0a1
+Requires-Dist: torch>=2.0
+Requires-Dist: transformers>=4.45
+Description-Content-Type: text/markdown
+
+# tigerflow-ml
+
+[![CI](https://github.com/princeton-ddss/tigerflow-ml/actions/workflows/ci.yml/badge.svg)](https://github.com/princeton-ddss/tigerflow-ml/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/tigerflow-ml)](https://pypi.org/project/tigerflow-ml/)
+[![Docs](https://img.shields.io/badge/docs-latest-blue)](https://princeton-ddss.github.io/tigerflow-ml/)
+
+ML tasks for [TigerFlow](https://github.com/princeton-ddss/tigerflow) — private cloud ML APIs on HPC infrastructure.
+
+## Installation
+
+```bash
+pip install tigerflow-ml
+```
+
+## Tasks
+
+| Task             | Description                         | Entry Point                       |
+|------------------|-------------------------------------|-----------------------------------|
+| OCR              | Extract text from images and PDFs   | `ocr` / `ocr-local`               |
+| Translation      | Translate text documents            | `translate` / `translate-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:
+
+```bash
+tigerflow tasks list
+```
+
+Run a task directly:
+
+```bash
+python -m tigerflow_ml.text.ocr.slurm --help
+python -m tigerflow_ml.text.translate.slurm --help
+python -m tigerflow_ml.audio.transcribe.slurm --help
+python -m tigerflow_ml.image.detect.slurm --help
+```
+
+## Development
+
+```bash
+uv sync --group dev
+uv run pre-commit run --all-files
+uv run pytest tests
+```

tigerflow_ml-0.1.0a0/README.md

@@ -0,0 +1,49 @@
+# tigerflow-ml
+
+[![CI](https://github.com/princeton-ddss/tigerflow-ml/actions/workflows/ci.yml/badge.svg)](https://github.com/princeton-ddss/tigerflow-ml/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/tigerflow-ml)](https://pypi.org/project/tigerflow-ml/)
+[![Docs](https://img.shields.io/badge/docs-latest-blue)](https://princeton-ddss.github.io/tigerflow-ml/)
+
+ML tasks for [TigerFlow](https://github.com/princeton-ddss/tigerflow) — private cloud ML APIs on HPC infrastructure.
+
+## Installation
+
+```bash
+pip install tigerflow-ml
+```
+
+## Tasks
+
+| Task             | Description                         | Entry Point                       |
+|------------------|-------------------------------------|-----------------------------------|
+| OCR              | Extract text from images and PDFs   | `ocr` / `ocr-local`               |
+| Translation      | Translate text documents            | `translate` / `translate-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:
+
+```bash
+tigerflow tasks list
+```
+
+Run a task directly:
+
+```bash
+python -m tigerflow_ml.text.ocr.slurm --help
+python -m tigerflow_ml.text.translate.slurm --help
+python -m tigerflow_ml.audio.transcribe.slurm --help
+python -m tigerflow_ml.image.detect.slurm --help
+```
+
+## Development
+
+```bash
+uv sync --group dev
+uv run pre-commit run --all-files
+uv run pytest tests
+```

tigerflow_ml-0.1.0a0/docs/mkdocs/assets/css/extra.css

@@ -0,0 +1,35 @@
+@import url("https://fonts.googleapis.com/css2?family=Pirata+One&display=swap");
+
+.md-header__button.md-logo img, .md-header__button.md-logo svg {
+    fill: currentcolor;
+    display: block;
+    height: 3.0rem;
+    width:auto
+}
+
+[dir=ltr] .md-header__title {
+    line-height: 2.5rem;
+    margin-left: .0rem;
+}
+
+.md-header__topic span {
+    line-height: 2.75rem;
+    font-family: 'Pirata One', sans-serif;
+    font-size: 2.0rem;
+    font-weight: 300;
+    text-transform: uppercase;
+}
+
+@media screen and (max-width: 1220px) { /* For smaller screens */
+    .md-header__topic span {
+        line-height: 2.6rem;
+        font-family: 'Pirata One', 'Roboto', sans-serif;
+        font-size: 1.3rem;
+        font-weight: 300;
+        text-transform: uppercase;
+    }
+}
+
+.md-main__inner {
+margin-top: 0;
+}

tigerflow_ml-0.1.0a0/docs/mkdocs/index.md

@@ -0,0 +1,53 @@
+---
+hide:
+  - navigation
+---
+<style>
+  .md-typeset h1,
+  .md-content__button {
+    /* display: none; */
+    margin-bottom: 0;
+  }
+</style>
+
+#
+
+<p align="center">
+  <img alt="tigerflow-ml-logo" src="assets/img/logo.png" width="350" />
+</p>
+
+<p align="center">
+    <a href="https://www.python.org">
+      <img alt="python-shield" src="https://img.shields.io/badge/Python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-3776AB.svg?style=flat&logo=python&logoColor=white"/>
+    </a>
+    <a href="https://opensource.org/licenses/MIT">
+      <img alt="mit-license" src="https://img.shields.io/badge/License-MIT-yellow.svg"/>
+    </a>
+    <a href="https://github.com/princeton-ddss/tigerflow-ml/actions/workflows/ci.yml">
+      <img alt="ci" src="https://github.com/princeton-ddss/tigerflow-ml/actions/workflows/ci.yml/badge.svg"/>
+    </a>
+    <a href="https://pypi.org/project/tigerflow-ml/">
+      <img alt="pypi" src="https://img.shields.io/pypi/v/tigerflow-ml"/>
+    </a>
+</p>
+
+**TigerFlow ML** is a [TigerFlow](https://github.com/princeton-ddss/tigerflow) task library extension that makes large-scale machine learning inference a breeze. Think of it as your replacement for expensive, opaque private cloud services. TigerFlow supports *batch inference* by running tasks on your organization's existing HPC resources using TigerFlow orchestration to optimize throughput and take advantage of unused compute cycles. Task logic is completely transparent and open source and relies on open-weight models available from the Hugging Face model hub (or bring your own). Tasks can be used on their own or incorporated into larger workflows using TigerFlow's pipeline construction.
+
+## Available Tasks
+
+- [OCR](tasks/ocr.md) — Extract text from images and PDFs
+- [Translation](tasks/translate.md) — Translate text documents
+- [Transcription](tasks/transcribe.md) — Transcribe audio to text
+- [Object Detection](tasks/detect.md) — Detect objects in images and videos
+
+## Installation
+
+TigerFlow ML requires [TigerFlow](https://github.com/princeton-ddss/tigerflow) to be installed.
+
+```bash
+pip install tigerflow tigerflow-ml
+```
+
+## Next Steps
+
+Check out the [Task Guide](tasks/ocr.md) for detailed usage, parameters, and examples.