What is a Code Run?

A Code Run object encapsulates vital information pertaining to a specific run within the Rhino Health FCP. The Code Run provides relevant information about ongoing and terminated runs, providing a comprehensive view of the run's execution and outcomes.

Key Aspects and Functions

1. Code Run Logs: One of the primary functions of the Code Run object is to provide seamless access to Code Run logs. These logs offer a detailed record of the run's execution at each relevant Rhino Client, facilitating troubleshooting, validation, and performance evaluation.

2. Input and Output Datasets: The Code Run object provides clear visibility into the input Datasets used for the run, as well as the naming conventions for the generated output Datasets. This transparency promotes effective traceability.

3. Runtime Insights: Access runtime information within the Code Run, including the time taken for the model to complete its execution. This insight aids in gauging performance and optimizing future runs.

4. Report Creation and Accessibility: Users have the flexibility to generate reports related to the model run and make them accessible via the Code Runs object. This feature aids in sharing insights and outcomes with collaborators or stakeholders.

Leveraging Code Runs for Insights and Collaboration

To make the most of Code Runs within the Rhino Health FCP, consider the following:

1. Comprehensive Analysis: Code Runs provide a holistic view of code executions, enabling you to analyze the effectiveness and outcomes of various runs.

2. Troubleshooting and Validation: Access Code Run logs to identify and address issues, ensuring the integrity and accuracy of your analyses.

3. Collaborative Sharing: Generate reports from the Code Run object to share insights with collaborators, enhancing collaborative research efforts.

Practical Application

Imagine you've run complex federated training with the NVFlare Code Object. By accessing the Code Run object associated with this run, you can review the input Datasets, configuration details, and execution time and delve into the Code Run logs. This comprehensive understanding empowers you to make informed decisions, validate results, and optimize future model runs.

Summary

Code Runs serve as the cornerstone of informed data analysis within the Rhino Health FCP. By encapsulating run configurations, runtime insights, logs, and reporting capabilities, the Code Run object empowers you to derive meaningful insights, troubleshoot effectively, and collaborate seamlessly with others. It's your gateway to unlocking the potential of your model executions.

Key Components of a Code Run

Attributes

1. Name: The name of the relevant Code Object
2. Description (Optional): The description of the Code Run
3. Type: The type of Code Object that has been run to produce the Code Run. In the case of NVFlare Code Runs, this will designate whether the Code Run row represents  NVFlare Training (T) or NVFlare Validation (V).
4. Run Time (UTC): The two timestamps for when the Code Run was started and ended in the UTC timezone
5. Status: The status of the Code Run, the value can be one of the following: Running, Complete: Success, Complete: Error, Halted: Success, Halted: Failure
6. Code Object Version: The version of the Code Object that was run to produce the Code Run
7. Input Datasets: A link to the Dataset Analytics view within the Datasets page showing all the input Datasets that were selected to run during the code's execution. If you hover over the link, you will see a list of the names of each input Dataset as well
8. Output Datasets: A link to the Dataset Analytics view within the Datasets page showing all the output Datasets that were selected to run during the code's execution. If you hover over the link, you will see a list of the names of each output Dataset as well
9. Report: A link to a report for the Code Run.  Reports by default are blank and meant to be a playground for users to output performance metrics they are especially interested in. Reports are created using the Rhino SDK. For more information, please refer to the Creating and Viewing a Code Run Report
10. Logs: The logs that were produced during the execution of the code.  By default, the logs show stdout and stderr.  If you are running code using a collaborator's Dataset, you might need to be granted special permissions to view the logs. They are extremely helpful for debugging.
11. UUID:  The unique identifier for a specific Code Run within the Rhino FCP

Actions

1. Viewing a Code Run’s Configuration: Viewing the configuration that was provided while creating a specific run
2. Review Code Run's Logs: Viewing the logs that have been produced as a result of a specific run
3. Creating and Viewing a Code Run Report: Creating a custom report using the Rhino SDK and viewing the report
4. Deleting a Code Run: Delete a single version or a whole Code Run Object

Interfaces

Below are a series of screenshots that detail how you can interact with Code Runs within the Rhino FCP

Main Code Runs Page

The main interface for viewing the output of a Code Object's run.

A Code Run that is still running

For more information about viewing logs while the code is still running, please refer to Review Code Run Logs.

A Code Run Logs Tab

For more information about viewing Code Run logs, please refer to Review Code Run Logs.

The Default Reports Tab for a Code Run

For more information about creating and viewing reports within a Code Run, please refer to Creating and Viewing a Code Run Report.

An Example Report Tab After Using the Rhino SDK to Push Details to It

For more information about creating and viewing reports within a Code Run, please refer to Creating and Viewing a Code Run Report.

Unsuccessful Code Runs

For more information about viewing Code Run logs and troubleshooting best practices, please refer to Review Code Run Logs and Troubleshooting Best Practices, respectively.

Code Run for Federated Training and Validation with NVFlare

The interface for viewing the results of an NVFlare Code Run. The interface shows two rows, one for training and the other for validation

An Active Code Run for an Interactive Container

For more information about opening Interactive Containers from the Code Runs page, please refer to Code Runs and Interactive Containers.

An Example of an Interactive Container That Has Been Opened From the Code Runs Page

For more information about opening Interactive Containers from the Code Runs page, please refer to Model Results and Interactive Containers.