Flyte 2 is available today for local execution - distributed execution coming to open source soon. Preview Flyte 2 for production, hosted on Union.ai

Report

Package: flyte.report

Parameters

        
    
class Report(
    name: str,
    tabs: typing.Dict[str, flyte.report._report.Tab],
    template_path: pathlib.Path,
)

Parameter	Type	Description
`name`	`str`
`tabs`	`typing.Dict[str, flyte.report._report.Tab]`
`template_path`	`pathlib.Path`

Method	Description
`get_final_report()`	Get the final report as a string.
`get_tab()`	Get a tab by name.

        
    
def get_final_report()

Get the final report as a string.

Returns: The final report.

        
    
def get_tab(
    name: str,
    create_if_missing: bool,
) -> flyte.report._report.Tab

Get a tab by name. If the tab does not exist, create it.

Parameter	Type	Description
`name`	`str`	The name of the tab.
`create_if_missing`	`bool`	Whether to create the tab if it does not exist.

Returns: The tab.