Visualizers

zenml.visualizers special

Initialization of the visualizers module.

The visualizers module offers a way of constructing and displaying visualizations of steps and pipeline results. The BaseVisualizer class is at the root of all the other visualizers, including options to view the results of pipeline runs, steps and pipelines themselves.

base_pipeline_run_visualizer

Implementation of the BasePipelineRunVisualizer.

BasePipelineRunVisualizer (BaseVisualizer)

The base implementation of a ZenML Pipeline Run Visualizer.

Source code in zenml/visualizers/base_pipeline_run_visualizer.py

class BasePipelineRunVisualizer(BaseVisualizer):
    """The base implementation of a ZenML Pipeline Run Visualizer."""

    @abstractmethod
    def visualize(
        self, object: PipelineRunView, *args: Any, **kwargs: Any
    ) -> None:
        """Method to visualize pipeline runs.

        Args:
            object: The pipeline run to visualize.
            *args: Additional arguments.
            **kwargs: Additional keyword arguments.
        """

visualize(self, object, *args, **kwargs)

Method to visualize pipeline runs.

Parameters:

Name	Type	Description	Default
object	PipelineRunView	The pipeline run to visualize.	required
*args	Any	Additional arguments.	()
**kwargs	Any	Additional keyword arguments.	{}

Source code in zenml/visualizers/base_pipeline_run_visualizer.py

@abstractmethod
def visualize(
    self, object: PipelineRunView, *args: Any, **kwargs: Any
) -> None:
    """Method to visualize pipeline runs.

    Args:
        object: The pipeline run to visualize.
        *args: Additional arguments.
        **kwargs: Additional keyword arguments.
    """

base_pipeline_visualizer

Implementation of the BasePipelineVisualizer.

BasePipelineVisualizer (BaseVisualizer)

The base implementation of a ZenML Pipeline Visualizer.

Source code in zenml/visualizers/base_pipeline_visualizer.py

class BasePipelineVisualizer(BaseVisualizer):
    """The base implementation of a ZenML Pipeline Visualizer."""

    @abstractmethod
    def visualize(self, object: PipelineView, *args: Any, **kwargs: Any) -> Any:
        """Method to visualize pipelines.

        Args:
            object: The pipeline to visualize.
            *args: Additional arguments.
            **kwargs: Additional keyword arguments.
        """

visualize(self, object, *args, **kwargs)

Method to visualize pipelines.

Parameters:

Name	Type	Description	Default
object	PipelineView	The pipeline to visualize.	required
*args	Any	Additional arguments.	()
**kwargs	Any	Additional keyword arguments.	{}

Source code in zenml/visualizers/base_pipeline_visualizer.py

@abstractmethod
def visualize(self, object: PipelineView, *args: Any, **kwargs: Any) -> Any:
    """Method to visualize pipelines.

    Args:
        object: The pipeline to visualize.
        *args: Additional arguments.
        **kwargs: Additional keyword arguments.
    """

base_step_visualizer

Implementation of the BaseStepVisualizer.

BaseStepVisualizer (BaseVisualizer)

The base implementation of a ZenML Step Visualizer.

Source code in zenml/visualizers/base_step_visualizer.py

class BaseStepVisualizer(BaseVisualizer):
    """The base implementation of a ZenML Step Visualizer."""

    @abstractmethod
    def visualize(self, object: StepView, *args: Any, **kwargs: Any) -> Any:
        """Method to visualize steps.

        Args:
            object: The step to visualize.
            *args: Additional arguments.
            **kwargs: Additional keyword arguments.
        """

visualize(self, object, *args, **kwargs)

Method to visualize steps.

Parameters:

Name	Type	Description	Default
object	StepView	The step to visualize.	required
*args	Any	Additional arguments.	()
**kwargs	Any	Additional keyword arguments.	{}

Source code in zenml/visualizers/base_step_visualizer.py

@abstractmethod
def visualize(self, object: StepView, *args: Any, **kwargs: Any) -> Any:
    """Method to visualize steps.

    Args:
        object: The step to visualize.
        *args: Additional arguments.
        **kwargs: Additional keyword arguments.
    """

base_visualizer

Implementation of the base class for all ZenML visualizers.

BaseVisualizer

Base class for all ZenML Visualizers.

Source code in zenml/visualizers/base_visualizer.py

class BaseVisualizer:
    """Base class for all ZenML Visualizers."""

    @abstractmethod
    def visualize(self, object: Any, *args: Any, **kwargs: Any) -> None:
        """Method to visualize objects.

        Args:
            object: The object to visualize.
            *args: Additional arguments.
            **kwargs: Additional keyword arguments.
        """

visualize(self, object, *args, **kwargs)

Method to visualize objects.

Parameters:

Name	Type	Description	Default
object	Any	The object to visualize.	required
*args	Any	Additional arguments.	()
**kwargs	Any	Additional keyword arguments.	{}

Source code in zenml/visualizers/base_visualizer.py

@abstractmethod
def visualize(self, object: Any, *args: Any, **kwargs: Any) -> None:
    """Method to visualize objects.

    Args:
        object: The object to visualize.
        *args: Additional arguments.
        **kwargs: Additional keyword arguments.
    """