Skip to content

Workflow

The Workflow is the component that enables the construction of one’s own Data Science & Machine Learning pipeline.

Workflow Management

To access the Workflow Management screen, use the side menu:

sidebar menu with Workflows section highlighted

Workflows management page

Viewing Workflows

From the Workflow management page you can view public workflows, team-owned workflows, and your private workflows.

For each workflow, the following functions are available:

Function Button
Execute execute workflow icon button
Create Template create template from existing workflow icon button
Edit edit workflow icon button
Delete delete workflow icon button

Clicking on the workflow card itself will instead open the Workflow detail panel.

Workflow details page

In the upper right corner, additional functions are available:

Workflow details page – top buttons set

Such as:

Function Button
View media content generated by the Workflow’s Services workflow media results button
Select Workflow version workflow version selector
Add Workflow to a Project workflow details page – manage projects icon button
Export Workflow workflow details page – export workflow icon button

On the same page, at the bottom, the following collapsible sections are also available:

  • Workflow: to interact with the Workflow’s components
  • Datasets: to view the list of input and output datasets together with a preview (dataset preview icon)

Workflow details – datasets collapsible section

  • Models: to view the list of input and output models, and to download them (model download icon)

Workflow details – models collapsible section

  • Schedules: to configure and view the workflow execution schedules

Workflow details – workflow schedulers section

The following sections describe in greater detail the above-mentioned functionalities.

Workflow Media (Multimedia Content)

By clicking on workflow media results button, the screen displaying the multimedia content created by the Workflow’s service components will open (see also the section Service – Workflow Media).

Application media panel open

From here you will be able to:

  1. View the multimedia content generated by each Service
  2. Select the specific execution run for which you want to view the content

Version Selection

Under development …

Workflow version selector

Add to a Project

By clicking on workflow details page – manage projects icon button, a dialog opens that allows you to add the Workflow to a Project.

The available Projects are those previously created via the dedicated section (Asset -> Projects).

Add Workflow to Project dialog

Export

By clicking on workflow details page – export workflow icon button, it becomes possible to export the Workflow in different formats:

  • Standalone
  • Manifest

Workflow export modes dialog with dropdown

By selecting the Standalone mode you can download a Docker Compose stack implementing the Workflow and designed for execution locally or on systems outside the Data Analytics System platform.

Selecting the Manifest mode allows you to download the equivalent Kubernetes version in JSON manifest format.

Scheduling

In the Schedules section it is possible to schedule the Workflow execution using Cron expressions.

Workflow details – workflow schedulers section

Workflow details – create workflow scheduler form

Creating a Workflow

  • For instructions on creating a Workflow, see the paragraph Create Workflow in the Quickstart section.
  • For the capabilities available in the Workflow Designer, refer to the Designer Overview.

In this section we will illustrate some additional functions useful during the creation and modification of a Workflow.

We will use the Workflow created during the Quickstart as a reference.

Quickstart Workflow

Initial Settings

Immediately after clicking the Create Workflow button, the following settings form opens:

Preliminary Workflow Settings

This form contains the following fields:

  • Access Level
  • Default Data Source

Access Level determines the visibility level of the Workflow asset (as described in the Basic Concepts section).

Default Data Source allows selection of the default DataSource to which all the Workflow’s Services will point for storing results. This default configuration can later be changed for each individual Service within the Workflow Designer (see the I/O Ports Settings section).

General Information

  • The Workflow Designer ensures only compatible ports can be connected.

I/O Ports Settings

By clicking on one of the ports of the blocks on the canvas, the Element Details panel opens. Its form content depends not only on the port type but also on the block type (service, dataset, …).

For example, by clicking on the input dataset port of a KMeans Service, one can select — through the relevant checkboxes — which dataset columns are actually passed to the Service.

Element details panel showing service input dataset port configurator

By clicking instead on the output dataset port of the Service, on the right side you can select the destination data source for the output dataset.

Element details panel showing service output dataset port configurator

Execution Target Selection for Services

For each Service component within a Workflow, it is possible to set a Target.

The Target determines the set of nodes of the Data Analytics System cluster that are candidates to run the assigned Services.

The available Targets must be pre-defined by the system administrator via the Control Panel (see Targets Management).

Authomatic Enhancement of Port Parameters

By connecting Service each other, the Data Analytics System will provide to assign the values ai valori (defined in the met-model) the arguments of the output port of a Service to the related input port of the next Service in the Workflow.

Example

two-services-coupling-example

Modifying a Workflow

It is possible to modify a Workflow — or quickly modify the properties of a Service it contains — by clicking the Edit Workflow button:

Edit Workflow icon button

Versioning

Each time a Workflow is modified it is versioned:

Workflow details page with Versions button highlighted

It is possible to designate a previous version as the default:

Workflow details page with Versions list and Default/Star button highlighted

Executing a Workflow

Once the Workflow has been configured and created, it can be executed or scheduled. If configured, the platform will also send associated notifications about the execution status.

Namespace Selection

By clicking the Execute Workflow button:

Execute Workflow icon button

If the system administrator has defined additional namespaces via the Control Panel, a popup will open to allow namespace selection.

Here it is sufficient to know that a namespace refers to a dedicated area of the cluster for workflow execution. Multiple namespaces may differ in terms of security policy, available compute resources and more (consult your system administrator for more information).

Workflow namespace selection popup

Possible Workflow States

  • READY: The Workflow has just been created and is ready for execution
  • STARTING: The Workflow is initializing. Resources are being allocated
  • RUNNING: The Workflow is currently executing
  • COMPLETED: The Workflow execution has completed. Results are available
  • STOPPED: The Workflow has been manually stopped by the user
  • ERROR: The Workflow was interrupted due to an error

Logs of Workflow Services

From the detail page of a Workflow that has been executed or is running, it is possible to access the logs of individual Service components that have passed the initialization stage (STARTING state).

By clicking the Show Logs button:

Show Logs button

The log viewing panel opens:

Workflow details page with Service logs dialog open

By clicking the Download Log Files button:

Download Log Files button

You can also download a local copy of the log files.

Deleting a Workflow

By clicking the Delete Workflow button:

Delete Workflow icon button

It will be possible to remove a Workflow from the catalog.

The system will ask for confirmation:

Workflow deletion confirmation button

Creating a Template

By clicking the Create Template from Existing Workflow button:

Create Template from Existing Workflow icon button

A Template will be created:

Workflows page with one Template

A Template is a special, non-executable copy of a Workflow available in the catalog as a basis for creating new Workflows. See also Template Management.

Use of MLflow

Workflows details page – Experiment

Figure: Workflow Experiment

If a model trained within a Workflow is of FML type, it is possible — via the Experiments button (Figure: Workflow Experiment) — to perform a comparison for algorithm selection, accessing the MLflow tool:

Workflows details page – MLflow tool

Figure: MLflow Tool