Skip to main content

Pip-installable, ready-to-run example models and pipelines for Michelangelo

Project description

michelangelo-examples

Test Build examples Docker image

Pip-installable, ready-to-run example models and pipelines for Michelangelo — a lightweight on-ramp for trying Michelangelo without a full monorepo checkout, the heavyweight example extra, or a running sandbox.

pip install michelangelo-examples[<example-name>]

Why this repo

The full example pipelines in michelangelo/python/examples/ are the canonical, full-fidelity reference — they exercise real Cadence/Temporal orchestration, Spark, and a live sandbox, and they aren't going anywhere. But trying one today means checking out the whole monorepo and installing one heavyweight extra that bundles every example's dependencies (torch, transformers, xgboost, pyspark, ray, mlflow, peft, and more) at once, regardless of which example you actually want.

michelangelo-examples is a second, lighter tier: each example is its own pip extra with only the dependencies it needs, plus a plain-Python run_local.py entrypoint that trains/evaluates locally — no Cadence, no Spark, no sandbox. It's the "try it in five minutes" path underneath the full pipeline reference, not a replacement for it.

Examples

Ported so far: california_housing — a project (use case) with one pipeline so far, pytorch_train (California Housing price prediction via PyTorch Lightning, migrated from core michelangelo's python/examples/pipelines/california_housing_lightning/). Structuring it as a project with a pipelines/ subfolder leaves room for sibling pipelines against the same use case — e.g. a future xgboost_train pipeline — without another top-level rename.

v1 candidates (not yet ported): movielens, bert-cola. See the project spec for the full list this repo is drawing from.

Each project lives entirely under src/michelangelo_examples/<project-name>/ — a real subpackage of the one michelangelo_examples package this repo ships, including its pipeline.yaml/README.md (bundled as package data so a plain pip install gets everything, not just the Python code) alongside each pipeline's model/training/task code and __main__.py local runner. Code shared across a project's sibling pipelines (e.g. dataset loading/feature prep) lives in <project-name>/pipelines/libs/.

Installing a project

pip install "michelangelo-examples[california-housing]"
python -m michelangelo_examples.california_housing.pipelines.pytorch_train

Extras are scoped per project, not per pipeline: installing california-housing pulls in the dependencies for every pipeline under that project (today just pytorch_train), since they already share one built image and mostly overlapping dependency sets.

The pip install + python -m commands above run the lightweight local tier only. To run a pipeline's full Cadence-dispatched version against a Michelangelo sandbox (ma project applyma pipeline applyma pipeline run), see the end-to-end command sequence in that pipeline's own README — e.g. pytorch_train's.

Relationship to other Michelangelo repos

  • michelangelo — the core platform; python/examples/ there remains the full pipeline reference (Cadence/Temporal/Spark/sandbox).
  • michelangelo-models — pluggable model architecture definitions. Some examples here may import a seed architecture from there instead of defining their own model.

Development

This repo uses uv for dependency management.

uv build
uv run pytest

License

Apache License 2.0

Project details


Download files

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

Source Distribution

michelangelo_examples-0.1.0.tar.gz (287.5 kB view details)

Uploaded Source

Built Distribution

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

michelangelo_examples-0.1.0-py3-none-any.whl (39.3 kB view details)

Uploaded Python 3

File details

Details for the file michelangelo_examples-0.1.0.tar.gz.

File metadata

  • Download URL: michelangelo_examples-0.1.0.tar.gz
  • Upload date:
  • Size: 287.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for michelangelo_examples-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e1acbdd3fc5b1310cff6417e1249e9d45a641976b759ee878da213eed89d1b5a
MD5 86046a56f43f2e54864a5f5a29f07749
BLAKE2b-256 dc7566a0cf42e57ee065f2e74e41250ba9faae26e2b2240cf842708c712ee823

See more details on using hashes here.

Provenance

The following attestation bundles were made for michelangelo_examples-0.1.0.tar.gz:

Publisher: release.yml on michelangelo-ai/michelangelo-examples

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file michelangelo_examples-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for michelangelo_examples-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5840aab55a5135795b6d81907f99b66651f1d599fd21766c9817d9641ebb64c9
MD5 6ad845d61ca11496df07651a56ccc4c6
BLAKE2b-256 d6530d9f9a4ba59b74765613451a6d2b33429b8775a5eb3798cb1eeb9b84cc4b

See more details on using hashes here.

Provenance

The following attestation bundles were made for michelangelo_examples-0.1.0-py3-none-any.whl:

Publisher: release.yml on michelangelo-ai/michelangelo-examples

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page