flytekit.deck

========== Flyte Deck

.. currentmodule:: flytekit.deck

Contains deck renderers provided by flytekit.

.. autosummary:: :nosignatures: :template: custom.rst :toctree: generated/

Deck TopFrameRenderer MarkdownRenderer SourceCodeRenderer

Directory

Classes

flytekit.deck.Deck

Deck enable users to get customizable and default visibility into their tasks.

Deck contains a list of renderers (FrameRenderer, MarkdownRenderer) that can generate a html file. For example, FrameRenderer can render a DataFrame as an HTML table, MarkdownRenderer can convert Markdown string to HTML

Flyte context saves a list of deck objects, and we use renderers in those decks to render the data and create an HTML file when those tasks are executed

Each task has a least three decks (input, output, default). Input/output decks are used to render tasks’ input/output data, and the default deck is used to render line plots, scatter plots or Markdown text. In addition, users can create new decks to render their data with custom renderers.

.. code-block:: python

iris_df = px.data.iris()

@task() def t1() -> str: md_text = ‘#Hello Flyte##Hello Flyte###Hello Flyte’ m = MarkdownRenderer() s = BoxRenderer(“sepal_length”) deck = flytekit.Deck(“demo”, s.to_html(iris_df)) deck.append(m.to_html(md_text)) default_deck = flytekit.current_context().default_deck default_deck.append(m.to_html(md_text)) return md_text

Use Annotated to override default renderer

@task() def t2() -> Annotated[pd.DataFrame, TopFrameRenderer(10)]: return iris_df

def Deck(
    name: str,
    html: typing.Optional[str],
    auto_add_to_deck: bool,
):

Methods

append()

def append(
    html: str,
):

publish()

def publish()

Properties

flytekit.deck.DeckField

DeckField is used to specify the fields that will be rendered in the deck.

def DeckField(
    args,
    kwds,
):

flytekit.deck.MarkdownRenderer

Convert a markdown string to HTML and return HTML as a unicode string.

Methods

to_html()

def to_html(
    text: str,
):

flytekit.deck.SourceCodeRenderer

Convert Python source code to HTML, and return HTML as a unicode string.

def SourceCodeRenderer(
    title: str,
):

Methods

to_html()

def to_html(
    source_code: str,
):

Convert the provided Python source code into HTML format using Pygments library.

This method applies a colorful style and replaces the color “#fff0f0” with “#ffffff” in CSS.

flytekit.deck.TopFrameRenderer

Render a DataFrame as an HTML table.

def TopFrameRenderer(
    max_rows: int,
    max_cols: int,
):

Methods

to_html()

def to_html(
    df: pandas.DataFrame,
):