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 build
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 build builds the model Docker images that the local_docker orchestrator runs each pipeline step in. just example runs all example 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
Reference implementations demonstrate the full workflow:
| Example | Task | Model | Run |
|---|---|---|---|
| Building footprints | Semantic segmentation | DINOv3 ViT-S/16 + UperNet (PyTorch) | just example dinov3s_buildings |
| Solid waste grid | Semantic segmentation | YOLO26x classifier (ultralytics) | just example yolo_swag_waste_grid_segmentation |
| RGB pixels (minimal) | Semantic segmentation | Logistic regression (scikit-learn) | just example sklearn_rgb_segmentation |
Commands
Run just to see all recipes.
just setup # install deps + bring up stack + register ZenML stack
just example # run all 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 |
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 fair_py_ops-0.3.10.tar.gz.
File metadata
- Download URL: fair_py_ops-0.3.10.tar.gz
- Upload date:
- Size: 3.9 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.12.10 {"installer":{"name":"uv","version":"0.12.10","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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d444aa091b93a8e07875aba9528655c210ce2c93cc20bec7f148c3d31f0c7da5
|
|
| MD5 |
8bbaa3375f5289e01ad9fc073264270d
|
|
| BLAKE2b-256 |
0ef602b9d9249f72720dd8238087259bd910501319bc778c1df045801c02d23b
|
File details
Details for the file fair_py_ops-0.3.10-py3-none-any.whl.
File metadata
- Download URL: fair_py_ops-0.3.10-py3-none-any.whl
- Upload date:
- Size: 4.1 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.12.10 {"installer":{"name":"uv","version":"0.12.10","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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2d787ff45ce1e9d410fa770a6bc97cf32ca9649763bfc5f67c08ca3815f35fa5
|
|
| MD5 |
15f52566cb0af83168a6a5c1d5ceb751
|
|
| BLAKE2b-256 |
81b620412a26611c1f7abb63f6e6a5bcba22e09ec3e7c34b0852afc24c7e93b4
|
