A Flow represents all existing flows with a certain name, in other words, classes derived from FlowSpec.
It is a container of Run objects for a particular flow.
Constructor
Flow(pathspec: Optional[str] = None)
Parameters
Flow name (e.g., ‘MyFlow’). Can also be None.
Properties
The flow ID (name).
latest_run
latest_run: Optional[Run]
latest_successful_run to get an object representing a completed successful run.
Returns: Latest Run of this flow or None.
latest_successful_run
latest_successful_run: Optional[Run]
Run of this flow or None.
Tags associated with the run this object belongs to (user and system tags).
user_tags: FrozenSet[str]
system_tags: FrozenSet[str]
created_at
Date and time this object was first created.
pathspec
Pathspec of this object (e.g., ‘FlowName’).
path_components
path_components: List[str]
Methods
runs()
runs(*tags: str) -> Iterator[Run]
Runs of this flow.
An optional filter is available that allows you to filter on tags. If multiple tags are specified, only runs that have all the specified tags are returned.
Parameters:
tags (str): Tags to match
Yields: Run objects in this flow.
__iter__()
__iter__() -> Iterator[Run]
Run of this Flow.
Note that only runs in the current namespace are returned unless _namespace_check is False.
Yields: Run objects in this Flow.
__getitem__()
__getitem__(run_id: str) -> Run
Run object with the run ID run_id.
Parameters:
Returns: Run for this run ID in this Flow.
Raises: KeyError if the run_id does not identify a valid Run object.
__contains__()
__contains__(id: str) -> bool
id (str): Name of the child object
Returns: True if the child exists or False otherwise.
is_in_namespace()
is_in_namespace() -> bool
Usage Examples
Access a flow and its runs
from metaflow import Flow
flow = Flow('MyFlow')
print(f"Latest run: {flow.latest_run}")
# Iterate over all runs
for run in flow:
print(f"Run {run.id}: finished={run.finished}")
Get latest successful run
from metaflow import Flow
flow = Flow('MyFlow')
run = flow.latest_successful_run
if run:
print(f"Latest successful run: {run.id}")
print(f"Data: {run.data}")
else:
print("No successful runs found")
from metaflow import Flow
flow = Flow('MyFlow')
# Get all runs with specific tags
for run in flow.runs('production', 'v2'):
print(f"Production v2 run: {run.id}")
Access a specific run
from metaflow import Flow
flow = Flow('MyFlow')
run = flow['123']
print(f"Run finished at: {run.finished_at}")
- Run - Run class for accessing run objects
- Metaflow - Entry point to the Metaflow universe
