fAIr-models

Model registry and ML pipeline orchestration for fAIr.

fair-py-ops is the Python package for building ZenML pipelines, validating STAC items, and testing locally. The models/ directory is the single source of truth for base model contributions.

Quick Start

Prerequisites: Docker, uv, just.

git clone https://github.com/hotosm/fAIr-models.git
cd fAIr-models
just setup
just example

just setup installs Python deps, brings up the full stack via Docker Compose (Postgres + MinIO + STAC + MLflow + ZenML), and registers the ZenML stack. just example runs all three reference pipelines end-to-end.

Service	URL	Credentials
ZenML dashboard	http://localhost:8080	`default` / (empty)
MLflow	http://localhost:5000	none
STAC API	http://localhost:8082	none
MinIO console	http://localhost:9001	`minioadmin` / `minioadmin`

See Getting Started for the full guide. For Kubernetes parity or production deploys, see infra/README.md.

Documentation

Getting Started : Installation and running the examples
Architecture : STAC catalog structure, flows, identity model, infrastructure
Contributing a Model : Guide for adding base models to fAIr
API Reference : Python package documentation
Changelog : Release history

Examples

Three reference implementations demonstrate the full workflow for each supported task:

Example	Task	Model	Path
Segmentation	Semantic segmentation	UNet (torchgeo)	`examples/segmentation/`
Classification	Binary classification	ResNet18 (torchvision)	`examples/classification/`
Detection	Object detection	YOLOv11n (ultralytics)	`examples/detection/`

Commands

Run just to see all recipes.

just setup     # install deps + bring up stack + register ZenML stack
just example   # run all 3 example pipelines
just down      # stop the stack (state preserved, fast restart)
just up        # restart after `just down`
just tear      # destroy stack + volumes + local ZenML state
just lint      # ruff + ty
just test      # pytest
just validate  # validate STAC items + model pipelines
just docs      # serve documentation locally
just commit    # run pre-commit hooks + commitizen

Key Concepts

Concept	Description
Base model	Reusable ML blueprint (weights, code, Docker image, STAC item)
Local model	Finetuned model produced by ZenML pipeline on user data
STAC catalog	Model/dataset registry with MLM and Version extensions
ZenML pipeline	Orchestrated training and inference workflows

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fair_py_ops-0.3.8.tar.gz (3.9 MB view details)

Uploaded Aug 28, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

fair_py_ops-0.3.8-py3-none-any.whl (4.1 MB view details)

Uploaded Aug 28, 2026 Python 3

File details

Details for the file fair_py_ops-0.3.8.tar.gz.

File metadata

Download URL: fair_py_ops-0.3.8.tar.gz
Upload date: Aug 28, 2026
Size: 3.9 MB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: uv/0.12.7 {"installer":{"name":"uv","version":"0.12.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for fair_py_ops-0.3.8.tar.gz
Algorithm	Hash digest
SHA256	`0e4aa6d3478e44ba1a80076a3b5d7a8440fb7befa372fa1f8dc443946afc2637`
MD5	`3a72efac41971d87347b4ed4a60e6877`
BLAKE2b-256	`2f93fb0f835509215f651e5c4d2173ddbf1eae4daf60fed2466647d8587bf505`

See more details on using hashes here.

File details

Details for the file fair_py_ops-0.3.8-py3-none-any.whl.

File metadata

Download URL: fair_py_ops-0.3.8-py3-none-any.whl
Upload date: Aug 28, 2026
Size: 4.1 MB
Tags: Python 3
Uploaded using Trusted Publishing? Yes
Uploaded via: uv/0.12.7 {"installer":{"name":"uv","version":"0.12.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for fair_py_ops-0.3.8-py3-none-any.whl
Algorithm	Hash digest
SHA256	`bfe5e0899bbb052f9119ca23a5d676274d1af781d648ac563e47d34ff4ef1f3c`
MD5	`45ea12e1ccfc07348cc2b415e67b747e`
BLAKE2b-256	`df14d46f950784fe042eccd0e1e481dd8052070ff0fd7676e263d63fef3295c9`