Skip to content

First Steps | tutorial-label

In this tutorial, you will create a simple Workflow to familiarize yourself with ALIDA. Specifically:

  • You will upload a new Dataset
  • You will create a Workflow that will read the Dataset and apply the K-means algorithm to it
  • You will run the Workflow
  • You will view the results obtained

1. Login

First, log in using the credentials provided to you by the administrator

2. Dataset Upload

Next, proceed to upload the Dataset. In ALIDA, a Dataset is a reference to a specific location within a Datasource. A Datasource is a reference to a storage service; such as an Object Store MinIO.

2.1 Download the Iris dataset in CSV format to your computer from the following URL:

2.2 Access the Dataset registration page as indicated in the following figures:

dashboard with burger icon highlighted

Access the sidebar menu through the burger icon

sidebar with datasets highlighted

Open the Datasets panel

datasets page

Open registration form

2.3 Fill in the form as indicated (see also figures):

  1. Name: Quickstart Iris
  2. Select the Datasource within which to upload the dataset: <your username>
  3. Open the Dataset upload panel by clicking the button upload-dataset-button

    dataset registration form with first steps highlighted

    Dataset registration form

  4. In the panel that opens, enter the name of the new folder to create (A): Quickstart Iris (the uploaded file will be saved within it)

  5. Select the Iris dataset downloaded in step 2.1 by clicking on "Upload files" (B)

    upload dataset dialog

    Dataset upload panel

    selected-files-recap

    Selected files recap

  6. Upload the file by clicking on upload-files-button

    file-successfully-uploaded-popup

    File/directory successfully uploaded

  7. Click on the newly created directory

    select-just-uploaded-directory

    List of directories for datasource

  8. Select the dataset path by clicking on the register-dataset-select-dataset-path-icon-button icon as indicated in the figure:

    load-just-uploaded-file-path

    Select dataset path

    Upon clicking, the dataset schema will be displayed at the bottom of the same page.

    register-dataset-schema-details-after-dataset-path-selection

    View selected dataset schema

  9. Click on Save. The dataset detail page will appear

    dataset-details-page-after-upload

    View newly created Dataset

3. Workflow Creation

3.1 At this point, access the Designer to create the Workflow as shown in the following figures:

sidebar-menu-with-workflows-item-highlighted

Access the Workflow catalog

create-workflow-button-highlighted

Create new Workflow

3.2 Fill in the Workflow settings form as indicated in the figure:

  • Access Level: Private
  • Default Data Source: <your.username>

and click on Confirm:

new-workflow-pre-settings.png

Workflow settings panel

You have reached the Workflow Designer, which will allow you to combine Datasets, Services and Models to create your Workflow:

workflow-designer-first-view

Workflow Designer page

3.4 Assemble the Workflow by dragging onto the Designer:

  1. The KMeans Service
  2. The Iris Dataset previously uploaded (under Datasets tab)

service-drag-n-drop

Drag and Drop the Service and Dataset you just created from the respective tabs

3.5 Connect the "Quickstart Iris" Dataset to the "KMeans" Service, dragging the Dataset port (🟢) and releasing it onto the service input port (🟢):

connecting-service-ports

Connect Dataset and Service

3.6 Assign a name to the Workflow from the right menu: Quickstart Iris

workflow-designer-assign-name-to-workflow

Assign name to Workflow

3.7 Click on the KMean Service on the canvas and select the default Target "Worker Nodes": select-default-target-in-workflow

Select Default Target in Workflow
The Target determines the set of cluster nodes eligible to host the Service execution

3.8 Finally, click on an empty point on the canvas and then on Create Workflow: save-workflow.png

Workflow creation button

Note

Within this brief tutorial, we do not cover the numerous configuration features of the Workflow and individual Services offered by ALIDA. For these, we refer the reader to the respective sections of this manual.

4. Workflow Execution

4.1 After creating the Workflow, on the resulting detail page, click on Run to execute it:

click-on-run-workflow

Run Workflow

4.2 After the execution is complete, the status bar will automatically switch to Completed:

completed-workflow-status-bar

Workflow status updated

5. Viewing Results

The Kmeans Service in use generates two types of output:

  1. A set of graphs
  2. A dataset that differs from the input dataset by adding a new column containing the result of the classification

5.1 Remaining on the Workflow detail page, view the graphs by clicking on Workflow Media:

application-media-button-highlighted

Media generated button

A panel with the graphs generated by the Workflow will open on the right:

kmeans-sample-plots

Graphs generated by Workflow

5.1 View the output dataset as follows:

  1. Scroll down the current Workflow detail page
  2. Open the Datasets section, and
  3. Click the Preview button (plain-preview-button) next to the output Dataset (output-dataset-tag-icon)

output-dataset-view-area.png

View output Dataset

A dialog will open, with a preview of the resulting Dataset. Note the new cluster column containing the processing results. output-dataset-data-preview-popup.png

Generated Dataset preview

6. Next Steps

Congratulations! You have just created and executed your first Workflow.

Continue exploring the concepts and features of ALIDA:

  • Visit the The Platform section to explore the ALIDA graphical interface
  • Visit the Assets section to learn more about the essential components of ALIDA
  • Visit the Service section and the tutorial on creating custom Services