Running a Code Object

To run a code object, complete the following steps.

1. Go to the main project's page and select your project.
2. Select Code from the menu on the left to open the Code Objects page.

3. Select the Run button for the code object you'd like to run.  
4. In the Run Settings page, do the following.

If your code object has one input and one output schema, do the following.

Fill in the following fields within the new Code Run configuration window (these steps are the same for the Python Snippet, Standalone File, and Upload File(s) options):

• Input Dataset(s): One or more Datasets to be used as input to your Code Run. If multiple Datasets are selected, each will be run separately. If a Dataset happens to be a collaborator's Dataset, the code will be run on that collaborator's Rhino Client. In other words, the data never moves outside your collaborator's Rhino Client
• Output Dataset Naming Template: A template to define the name of the output Dataset that will be created during your Code Run. The following variables can be used for creating a dynamic name: {{workgroup_name}}, {{workgroup_uid}}, {{code_object_name}}, {{input_dataset_names.n}} where n is the dataset number, and {{input_sal_names.n}}.
• Timeout in Seconds: The number of seconds that must elapse before a Code Run is automatically halted. This is to avoid zombie tasks that run perpetually within a Rhino client.
• Run Parameters (Optional): Here you can paste a JSON object that defines additional parameters to be provided to your Code Run. This can be used for specifying hyper-parameters for model validation or any parameter provided to the code. Run parameters are made available to the container code in a file located at "/input/run_params.json". See more detail how to in How to pass to and use parameters in your code?
• Run Secrets (Optional): Here you can paste a JSON object that defines additional secret parameters to be provided to your Code Run. This can be used for specifying encryption keys or other secrets that will not be persisted after code run. These secrets are made available to the container code in a file located at "/input/secret_run_params.json". 
• See how more detail how to in How to pass to and use parameters in your code?
• Include Run Time Files: Select any external files that you want to use within your code. This allows to use the same code object with different files, specially if these files are large, such as different LLM models.

NOTE:  Files that you want to run at run-time should be uploaded to the Rhino Orchestrator.  See https://docs.rhinohealth.com/hc/en-us/articles/19768490444317-How-to-use-external-files-at-run-time for more details.

To add run time files to your code run, select the run time files from the list of the workgroup run files that appears.  You will want to only include the ones you need for the code run, like in the example that follows.

Note that your workgroup run time files include both published and unpublished files.  Files from other workgroups only include the files that they have published and have made visible to you and others in your workgroup that share the same persona.  (Note that for collaborators to have access to files, they must be published.  See Managing Run Time Files to learn how to publish run time files.)

If your code object has multiple input or one output schemas, do the following.

When your code object has multiple input and/or output schemas, you have to define the following additional fields:

• Workgroup and input datasets: The workgroup and input dataset(s) to run your code on. 
• Add Workgroup: If you want to run the code object in more than one workgroup, this button allows you to input additional workgroups and corresponding datasets.
• Output naming template: If your code object has more than one output data schema define, here you input the output naming template for each output dataset. 

Additional Fields for Code Type

Depending on the type of Code Object you are trying to run, you will be prompted with additional fields to complete. Follow the links below to finish the creation of your Code Run:

• Running a Python Code Object
• Running a Generalized Compute Code Object
• Running an Interactive Container Code Object
• Running an NVFlare Code Object

Troubleshooting Code Runs

Error Message that Usage Limit Has Been Exceeded

If you get an error message indicating that the usage limit has been exceeded, your administrator has set usage limits on the number of input rows a workgroup can process per model within a certain timeframe.  Getting this message means that the entire run has been cancelled.  Please contact your administrator for more details and help with resolving the issue.