flow¶

class virtualitics_sdk.flow.flow.App(name, description, image_path=None, is_shareable=False, sort_key=None)¶

Bases: object

An App represent a workflow in the Virtualitics AI Platform. An App can contain many Step’s that can get inputs, run computation, and show results.

Parameters:

name (str) – The name of the App.
description (str) – The App description
image_path (Optional[str]) – The base64 encoding of an image or a public link to an image, defaults to None
is_shareable (bool) – Whether a given App is shareable, defaults to False
sort_key (Optional[str]) – An optional value to sort the App by, this controls the sort order of Apps on the home page

EXAMPLE:

# Imports 
from virtualitics_sdk import App
. . .
# Example usage
tile_image_link = "https://example-image.jpeg"
example_flow = App(name="Example App", 
                          description="Simple example for using App class",
                          image_path=tile_image_link)

chain(ordered_steps, lock=True)¶

Add all steps to the App’s workflow with one function. Locks Apps by default.

Parameters:: ordered_steps (List[Step]) – Ordered list of Steps to be added.

get_data(app_id=None)¶

virtualitics_sdk.flow.flow.Flow¶: alias of App