This can be downloaded as part of the Wallaroo Tutorials repository.

Wallaroo Connection and ML Workload Orchestration Simple Tutorial

This tutorial provides a quick set of methods and examples regarding Wallaroo Connections and Wallaroo ML Workload Orchestration. For full details, see the Wallaroo Documentation site.

Wallaroo provides Data Connections and ML Workload Orchestrations to provide organizations with a method of creating and managing automated tasks that can either be run on demand or a regular schedule.

Definitions

• Orchestration: A set of instructions written as a python script with a requirements library. Orchestrations are uploaded to the Wallaroo instance as a .zip file.
• Task: An implementation of an orchestration. Tasks are run either once when requested, on a repeating schedule, or as a service.
• Connection: Definitions set by MLOps engineers that are used by other Wallaroo users for connection information to a data source. Usually paired with orchestrations.

Tutorial Goals

The tutorial will demonstrate the following:

1. Create a Wallaroo connection to retrieving information from an external source.
2. Upload Wallaroo ML Workload Orchestration.
3. Run the orchestration once as a Run Once Task and verify that the information was saved the pipeline logs.
4. Schedule the orchestration as a Scheduled Task and verify that the information was saved to the pipeline logs.

Prerequisites

• An installed Wallaroo instance.
• The following Python libraries installed. These are included by default in a Wallaroo instance’s JupyterHub service.
  • os
  • wallaroo: The Wallaroo SDK. Included with the Wallaroo JupyterHub service by default.
  • pandas: Pandas, mainly used for Pandas DataFrame
  • pyarrow: PyArrow for Apache Arrow support

Initial Steps

For this tutorial, we’ll create a workspace, upload our sample model and deploy a pipeline. We’ll perform some quick sample inferences to verify that everything it working.

Load Libraries

Here we’ll import the various libraries we’ll use for the tutorial.

import wallaroo
from wallaroo.object import EntityNotFoundError, RequiredAttributeMissing

# to display dataframe tables
from IPython.display import display
# used to display dataframe information without truncating
import pandas as pd
pd.set_option('display.max_colwidth', None)
pd.set_option('display.max_columns', None)
import pyarrow as pa

import time

Connect to the Wallaroo Instance

The first step is to connect to Wallaroo through the Wallaroo client. The Python library is included in the Wallaroo install and available through the Jupyter Hub interface provided with your Wallaroo environment.

This is accomplished using the wallaroo.Client() command, which provides a URL to grant the SDK permission to your specific Wallaroo environment. When displayed, enter the URL into a browser and confirm permissions. Store the connection into a variable that can be referenced later.

If logging into the Wallaroo instance through the internal JupyterHub service, use wl = wallaroo.Client(). For more information on Wallaroo Client settings, see the Client Connection guide.

# Login through local Wallaroo instance

wl = wallaroo.Client()

# Setting variables for later steps

workspace_name = f'simpleorchestrationworkspace'
pipeline_name = f'simpleorchestrationtutorial'
model_name = f'simpleorchestrationmodel'
model_file_name = './models/rf_model.onnx'

inference_connection_name = f'external_inference_connection_sample'
inference_connection_type = "HTTP"
inference_connection_argument = {'host':'https://github.com/WallarooLabs/Wallaroo_Tutorials/raw/main/wallaroo-automate/orchestration_sdk_simple_tutorial/data/xtest-1k.arrow'}

Create the Workspace and Pipeline

We’ll now create our workspace and pipeline for the tutorial. If this tutorial has been run previously, then this will retrieve the existing ones with the assumption they’re for us with this tutorial.

We’ll set the retrieved workspace as the current workspace in the SDK, so all commands will default to that workspace.

workspace = wl.get_workspace(name=workspace_name, create_if_not_exist=True)
wl.set_current_workspace(workspace)

pipeline = wl.build_pipeline(pipeline_name)

Upload the Model and Deploy Pipeline

We’ll upload our model into our sample workspace, then add it as a pipeline step before deploying the pipeline to it’s ready to accept inference requests.

# Upload the model

housing_model_control = (wl.upload_model(model_name, 
                                         model_file_name, 
                                         framework=wallaroo.framework.Framework.ONNX)
                                         .configure(tensor_fields=["tensor"])
                        )

# Add the model as a pipeline step

pipeline.clear()
pipeline.add_model_step(housing_model_control)

#deploy the pipeline
pipeline.deploy(wait_for_status=False)

Deployment initiated for simpleorchestrationtutorial. Please check pipeline status.

# check the pipeline status before performing an inference

import time

while pipeline.status()['status'] != 'Running':
   time.sleep(15)

pipeline.status()

{'status': 'Running',
 'details': [],
 'engines': [{'ip': '10.28.0.3',
   'name': 'engine-c6995ccd4-kbhd7',
   'status': 'Running',
   'reason': None,
   'details': [],
   'pipeline_statuses': {'pipelines': [{'id': 'simpleorchestrationtutorial',
      'status': 'Running',
      'version': 'de61b33b-cb0d-46ae-aa24-5a51e5287d87'}]},
   'model_statuses': {'models': [{'model_version_id': 5,
      'name': 'simpleorchestrationmodel',
      'sha': 'e22a0831aafd9917f3cc87a15ed267797f80e2afa12ad7d8810ca58f173b8cc6',
      'status': 'Running',
      'version': 'd9ee6c33-8a50-41b6-92f6-5c1b6cdeec17'}]}}],
 'engine_lbs': [{'ip': '10.28.0.4',
   'name': 'engine-lb-6676794678-p8x2d',
   'status': 'Running',
   'reason': None,
   'details': []}],
 'sidekicks': []}

Create Connections

We will create the data source connection via the Wallaroo client command create_connection.

Connections are created with the Wallaroo client command create_connection with the following parameters.

• IMPORTANT NOTE: Data connections names must be unique. Attempting to create a data connection with the same name as an existing data connection will result in an error.

We’ll also create a data connection named inference_results_connection with our helper function get_connection that will either create or retrieve a connection if it already exists. From there we’ll create out connections:

• houseprice_arrow_table: An Apache Arrow file stored on GitHub that will be used for our inference input.

wl.create_connection(inference_connection_name, inference_connection_type, inference_connection_argument)

Get Connection by Name

The Wallaroo client method get_connection(name) retrieves the connection that matches the name parameter. We’ll retrieve our connection and store it as inference_source_connection.

inference_source_connection = wl.get_connection(name=inference_connection_name)
display(inference_source_connection)

Add Connection to Workspace

The method Workspace add_connection(connection_name) adds a Data Connection to a workspace, and takes the following parameters.

We’ll add both connections to our sample workspace, then list the connections available to the workspace to confirm.

workspace.add_connection(inference_connection_name)
workspace.list_connections()

Wallaroo ML Workload Orchestration Example

With the pipeline deployed and our connections set, we will now generate our ML Workload Orchestration. See the Wallaroo ML Workload Orchestrations guide for full details.

Orchestrations are uploaded to the Wallaroo instance as a ZIP file with the following requirements:

For our example, our orchestration will:

1. Use the inference_results_connection to open a HTTP Get connection to the inference data file and use it in an inference request in the deployed pipeline.
2. Submit the inference results to the location specified in the external_inference_connection.

This sample script is stored in remote_inference/main.py with an empty requirements.txt file, and packaged into the orchestration as ./remote_inference/remote_inference.zip. We’ll display the steps in uploading the orchestration to the Wallaroo instance.

Note that the orchestration assumes the pipeline is already deployed.

Upload the Orchestration

Orchestrations are uploaded with the Wallaroo client upload_orchestration(path) method with the following parameters.

Once uploaded, the deployment will be prepared and any requirements will be downloaded and installed.

For this example, the orchestration ./remote_inference/remote_inference.zip will be uploaded and saved to the variable orchestration.

Orchestration Status

We will loop until the uploaded orchestration’s status displays ready.

orchestration = wl.upload_orchestration(path="./remote_inference/remote_inference.zip")

while orchestration.status() != 'ready' and orchestration.status() != 'error':
    print(orchestration.status())
    time.sleep(5)

pending_packaging
packaging
packaging
packaging
packaging
packaging
packaging
packaging
packaging

wl.list_orchestrations()

Upload Orchestration via File Object

Another method to upload the orchestration is as a file object. For that, we will open the zip file as a binary, then upload it using the bytes_buffer parameter to specify the file object, and the file_name to give it a new name.

zipfile = open("./remote_inference/remote_inference.zip", "rb").read()

wl.upload_orchestration(bytes_buffer=zipfile, file_name="inferencetest.zip", name="uploadedbytesdemo")

wl.list_orchestrations()

Task Management Tutorial

Once an Orchestration has the status ready, it can be run as a task. Tasks have three run options.

Run Task Once

We’ll do both a Run Once task and generate our Run Once Task from our orchestration.

Tasks are generated and run once with the Orchestration run_once(name, json_args, timeout) method. Any arguments for the orchestration are passed in as a Dict. If there are no arguments, then an empty set {} is passed.

# Example: run once

import datetime
task_start = datetime.datetime.now()
task = orchestration.run_once(name="simpletaskdemo", 
                              json_args={"workspace_name": workspace_name, 
                                         "pipeline_name": pipeline_name,
                                         "connection_name": inference_connection_name
                                            })

Task Status

The list of tasks in the Wallaroo instance is retrieves through the Wallaroo Client list_tasks() method. This returns an array list of the following.

For this example, the status of the previously created task will be generated, then looped until it has reached status started.

while task.status() != "started":
    display(task.status())
    time.sleep(5)

'pending'
‘pending’

Task Results

We can view the inferences from our logs and verify that new entries were added from our task. We can do that with the task last_runs() method to see the list of task runs executed, then show the log from the last completed task run.

task.last_runs()[0]

task.last_runs()[0].logs()

(no logs yet)

Scheduled Run Task Example

The other method of using tasks is as a scheduled run through the Orchestration run_scheduled(name, schedule, timeout, json_args). This sets up a task to run on an regular schedule as defined by the schedule parameter in the cron service format. For example:

schedule={'42 * * * *'}

Runs on the 42nd minute of every hour.

The following schedule runs every day at 12 noon from February 1 to February 15 2024 - and then ends.

schedule={'0 0 12 1-15 2 2024'}

For our example, we will create a scheduled task to run every 5 minutes, display the inference results, then use the Orchestration kill task to keep the task from running any further.

It is recommended that orchestrations that have pipeline deploy or undeploy commands be spaced out no less than 5 minutes to prevent colliding with other tasks that use the same pipeline.

scheduled_task = orchestration.run_scheduled(name="simple_inference_schedule", 
                                             schedule="*/5 * * * *", 
                                             timeout=120, 
                                             json_args={"workspace_name": workspace_name, 
                                                        "pipeline_name": pipeline_name,
                                                        "connection_name": inference_connection_name
                                            })

while scheduled_task.status() != "started":
    display(scheduled_task.status())
    time.sleep(5)

#wait 420 seconds to give the scheduled event time to finish
time.sleep(420)
scheduled_task.last_runs()[0].logs()

2024-09-Dec 21:05:02 WALLAROO: Setting up task run...
2024-09-Dec 21:05:05 WALLAROO: *** If you don't see any output, Python is probably buffering stdout.                       ***
2024-09-Dec 21:05:05 WALLAROO: *** Consider `print('...', flush=True)` or `sys.stdout.flush()` in your orchestration code. ***
2024-09-Dec 21:05:08 Getting the workspace simpleorchestrationworkspace
2024-09-Dec 21:05:05 WALLAROO: Task environment ready. Running...
2024-09-Dec 21:05:08 Getting the pipeline simpleorchestrationtutorial
2024-09-Dec 21:05:08 Getting arrow table file
2024-09-Dec 21:05:08 Inference time.  Displaying results after.
2024-09-Dec 21:05:08 1 2024-12-09 21:05:08.782  ...             0
2024-09-Dec 21:05:08 0 2024-12-09 21:05:08.782  ...             0
2024-09-Dec 21:05:08                      time  ... anomaly.count
2024-09-Dec 21:05:08 2 2024-12-09 21:05:08.782  ...             0
2024-09-Dec 21:05:08 3 2024-12-09 21:05:08.782  ...             0
2024-09-Dec 21:05:08 4 2024-12-09 21:05:08.782  ...             0
2024-09-Dec 21:05:08 
2024-09-Dec 21:05:08 [5 rows x 4 columns]
2024-09-Dec 21:05:09 WALLAROO: Task run complete. Status: success

Kill Task

With our testing complete, we will kill the scheduled task so it will not run again. First we’ll show all the tasks to verify that our task is there, then issue it the kill command.

wl.list_tasks()

scheduled_task.kill()

<ArbexStatus.PENDING_KILL: ‘pending_kill’>

wl.list_tasks()

Cleanup

With the tutorial complete, we can undeploy the pipeline and return the resources back to the Wallaroo instance.

pipeline.undeploy()

View Orchestrations with Filter

The following examples show listing and retrieving orchestrations and tasks with additional filters.

List Orchestrations

List all orchestrations available across workspaces, then filtered by workspace id, then filtered by workspace name.

wl.list_orchestrations()

wl.list_orchestrations(workspace_id=workspace.id())

wl.list_orchestrations(workspace_name=workspace_name)

List Tasks

Lists all tasks available across workspaces, then filtered by workspace id, then filtered by workspace name.

wl.list_tasks()

wl.list_tasks(workspace_id=workspace.id())

wl.list_tasks(workspace_name=workspace_name)