Follow

How to Start Runs in Domino

A "Run" is the execution of code or an interactive notebook session in a Domino container. Runs are how you will iterate through experiments, speed up your calculations and improve your analytic workflow. 

  • Each Run keeps a snapshot of all your files, including any "results" the code creates, including charts, tables, data files, and serialized model data. All assets are versioned and can be compared across different Runs.
  • All results and runs are visible through the web interface, accessible by your collaborators from anywhere.
  • You can start multiple concurrent Runs — each gets its own machine, so you can try multiple parameters and techniques in parallel.
  • You can schedule recurring runs, and set up notifications, including customized reports, to go out to your team.

Starting a Run in Domino

Domino offers several ways to launch runs: from the Runs dashboard, from the file itself, via schedulers, or via launchers.

The Runs dashboard

When you open a project’s Runs dashboard, the first thing you’ll see is a list of the project’s past run results. 

In order to launch a run from this dashboard, click the Run button. A dialog will appear asking for the name of the file to run. Specify the file you want to run, as well as any optional arguments you’d like to pass to your file, and click the Start Run button.

 

Your run will start.

  

Files menu

You can also run a file directly from the Files menu. Simply find the file you want to run and click the Settings icon on the far-right side of the file list.

From the drop-down menu, select Run. Domino will then ask you to specify optional parameters for the run.

  • Title: In this field, enter a name for the run.
  • Parameters: If there are any arguments or parameters you’d like to pass to your script, enter them here.
  • Hardware tier: This drop-down list enables you to set the hardware tier used by the run.
  • Schedule to repeat: In this section, specify if you want the run to execute only once, or to repeat on a schedule. You can also add a custom expression here.
  • Publish after complete: Check this if you want Domino to publish your API endpoint once the run completes successfully. Learn more about API Endpoints here

Once you have set all the parameters to your liking, click Start Run. Domino will launch your run.

 

The Domino CLI

From your workstation, you can start runs through the Domino CLI . If you haven't yet installed the CLI, follow these instructions to install it on your system.

Once logged in, you can start runs by typing
domino run <filename>

The Domino CLI is very flexible - see all the possible options for launching runs here

Examples

domino run calculateStats.r
domino run runModel.m model1 .05
domino run --wait runModel.m model1 .05
domino run --direct "pip freeze | grep pandas"

 

Scheduling a run

Domino allows you to schedule runs in advance, setting them to execute on a regular schedule. These can be useful when you have a data source that is updated regularly, and you conduct regular analyses on that source.

To schedule a run, go to the left-hand sidebar and click Schedule, which you will find directly below Runs. Domino will then display the Scheduled Runs dialog.

  • Command to run: Enter the name of the file you’d like to run. Include any optional arguments you wish to pass to your file prior to the run.
  • Publish after complete: Check this if you want Domino to publish your API endpoint once the run completes successfully.
  • Schedule options: Here you can set the frequency at which you want the run to repeat. Or use a custom expression, in Quartz CronTrigger Format.
  • Pause schedule: Checking this box prevents the runs from executing on the specified schedule.
  • Run Sequentially or Run Concurrently: Some runs cannot begin unless they have access to output from prior runs. By selecting Run Sequentially, you will ensure that each run will begin only when the preceding run is complete. By contrast, Run Concurrently allows runs to launch completely independently of each other, and should be used when your run doesn’t require output from previous runs.
  • Emails to notify: In this field, add the email addresses of everyone who should be notified when the run completes.
  • Hardware tier: This drop-down list enables you to set the hardware tier used by the run.
  • Title: In this field, enter a name for the run.

Once you have entered all the specifications for your run, click the Schedule button.

For more on managing your scheduling runs, see the Scheduling Runs article in Domino’s knowledge base.

Using Launchers

A launcher is essentially a web form that rests atop a script that Domino can run--for example, anything you could run via the command line. You can use a launcher to pass arguments to your script or executable, and these can then be exposed as UI elements in the web form.

When creating a launcher, you will have to specify the command to run when the launcher is launched. Once you have set up your launcher, click the Save Launcher button. Next, click Back to Launchers to see an up-to-date list of launchers for this project.

Clicking the Run button will launch the launcher. This is functionally equivalent to executing a run using any of the other methods described earlier.

For more information on using launchers, see the Launchers article in Domino’s knowledge base.

Was this article helpful?
0 out of 0 found this helpful

Comments