Create Template Run

Class for defining a pipeline schedule.

Attributes: name: Optional name to give to the schedule. If not set, a default name will be generated based on the pipeline name and the current date and time. cron_expression: Cron expression for the pipeline schedule. If a value for this is set it takes precedence over the start time + interval. start_time: datetime object to indicate when to start the schedule. end_time: datetime object to indicate when to end the schedule. interval_second: datetime timedelta indicating the seconds between two recurring runs for a periodic schedule. catchup: Whether the recurring run should catch up if behind schedule. For example, if the recurring run is paused for a while and re-enabled afterward. If catchup=True, the scheduler will catch up on (backfill) each missed interval. Otherwise, it only schedules the latest interval if more than one interval is ready to be scheduled. Usually, if your pipeline handles backfill internally, you should turn catchup off to avoid duplicate backfill. run_once_start_time: datetime object to indicate when to run the pipeline once. This is useful for one-off runs.

Model class to pass into pipeline or step to set it into a model context.

name: The name of the model. license: The license under which the model is created. description: The description of the model. audience: The target audience of the model. use_cases: The use cases of the model. limitations: The known limitations of the model. trade_offs: The tradeoffs of the model. ethics: The ethical implications of the model. tags: Tags associated with the model. version: The version name, version number or stage is optional and points model context to a specific version/stage. If skipped new version will be created. save_models_to_registry: Whether to save all ModelArtifacts to Model Registry, if available in active stack. model_version_id: The ID of a specific Model Version, if given - it will override name and version settings. Used mostly internally.

Retry configuration for a step.

Delay is an integer (specified in seconds).

Source specification.

A source specifies a module name as well as an optional attribute of that module. These values can be used to import the module and get the value of the attribute inside the module.

Example: The source Source(module="zenml.config.source", attribute="Source") references the class that this docstring is describing. This class is defined in the zenml.config.source module and the name of the attribute is the class name Source.

Attributes: module: The module name. attribute: Optional name of the attribute inside the module. type: The type of the source.

Source specification.

A source specifies a module name as well as an optional attribute of that module. These values can be used to import the module and get the value of the attribute inside the module.

Example: The source Source(module="zenml.config.source", attribute="Source") references the class that this docstring is describing. This class is defined in the zenml.config.source module and the name of the attribute is the class name Source.

Attributes: module: The module name. attribute: Optional name of the attribute inside the module. type: The type of the source.

Response body for pipeline runs.

Response metadata for pipeline runs.

Class for all resource models associated with the pipeline run entity.