Skip to main content

Python SDK Reference

Auto-generated reference for the michelangelo Python package. Run bun run docs:api from the website/ directory to generate the per-module pages below from source docstrings — until then, this page lists the modules covered without linking to pages that don't exist yet.

Uniflow — Tasks & Workflows

The core authoring surface for pipeline tasks and workflows.

ModuleDescription
uniflow.core.decorator@task and @workflow decorators
uniflow.core.task_configBase task configuration types
uniflow.core.contextExecution context passed into tasks
uniflow.core.image_specImageSpec for per-task container images
uniflow.core.io_registryDataset IO type registry

Uniflow — Plugins

Compute-backend plugins that extend @task with Ray, Spark, or Pandas execution.

ModuleDescription
uniflow.plugins.ray.taskRayTask config for Ray-backed tasks
uniflow.plugins.ray.run_configRay run configuration
uniflow.plugins.ray.ioRay dataset IO
uniflow.plugins.spark.taskSparkTask config for Spark-backed tasks
uniflow.plugins.spark.ioSpark dataset IO
uniflow.plugins.pandas.ioPandas dataset IO

CanvasFlex — Pusher

The pusher component for CanvasFlex template-driven workflows.

ModuleDescription
workflow.tasks.pusher.taskPusher task definition
workflow.tasks.pusher.registryPusher plugin registry
workflow.tasks.pusher.exceptionsPusher exception types

Trainer

PyTorch training utilities used with LightningTrainer.

ModuleDescription
lib.trainer.torch.data_collate_functionsCollate functions for data loading
lib.trainer.torch.utilsTrainer utilities

Native Transform

TorchScript- and ONNX-exportable transform layers for train/serve parity.

ModuleDescription
lib.native_transform.torch.base_layersBase transform layer classes
lib.native_transform.torch.id_hash_tokenizerID hashing tokenizer layer
lib.native_transform.torch.utilsTransform utilities

Workflow Variables

Typed dataset and metadata variables for pipeline IO.

ModuleDescription
workflow.variables.typesDatasetVariable and related types
workflow.variables.metadataVariable metadata types