Skip to main content

Creating a New Generalized Compute Code Object

Creating a New Generalized Compute Code Object using the Rhino FCP UI

Navigate to the Code (formerly Models) Page

Project Dashboard.png

Use the left-hand navigation menu to click the Code menu item

 

Add a New Code Object

Models Main Page.png

Create a new model by clicking on the Create New Code Object button in the top-right corner

 

Enter your New Code Object Details

Create a Model-Generalized Compute.png

Fill in the following fields within the new modal window:

  1. Name: The name you would like to provide for your Code Object
  2. Description: A description that will help you understand the nature of the Code Object
  3. Type:  Generalized Compute
  4. Input Data Schema: The Data Schema for the Dataset this Code Object will accept as input. Your selection here will affect which Datasets can be selected as input when triggering a Code Run with this Code Object.
  5. Output Data Schema: The Data Schema for the Dataset that will be created as output when triggering a Code Run with this Code Object.  You can also select the option to [Auto-generate Data Schema from Data]. For more information about Auto-generating Data Schemas, please refer to Auto-Generated Data Schemas.
  6. Container: The Docker container you would like to execute when running this Code Object. This will either be a container image created by someone from your workgroup that is available on your ECR or an image provided by Rhino Health.  If you need a refresher on pushing containers to your ECR, please refer to Pushing Containers to the ECR.

When you have completed adding all your Generalized Compute Code details, click the Create New Code button to create your new Code.

 

Creating a New Generalized Compute Code Object Version

To create a new version, make sure you are on the page containing the original object you would like to create a new version of.  In the box where your original object is in the upper right-hand corner, you should see a + New Version button, like the one shown below:

New Version Button.png

Click that button and a new dialog should appear that will allow you to create a new version of your object.

 

Creating a New Version in Every Interface within the Rhino FCP UI

Below is a GIF showing all the interfaces within the Rhino FCP application where you can create a new Version. It displays the Schemas, Cohorts, and Models pages and the + New Version button you will press to create that new version of the schema, cohort, or model you are looking to create.

new_version.gif

 

 

Creating a New Generalized Compute Code Object using the Rhino SDK

Prerequisites

Before starting this process, you should have already:

  1. Created a Project using the Rhino SDK or UI
  2. Created an Input Data Schema using the Rhino SDK or UI
  3. [Optional] Created an Output Data Schema using the Rhino SDK or UI. If you choose not to create an output Data Schema, the system will auto-generate the Data Schema of the output for your Code

 

Import your Python Dependencies

import rhino_health as rh
from rhino_health.lib.endpoints.code.code_objects_dataclass import (
    CodeObject,
    CodeObjectCreateInput,
    CodeTypes,
    CodeRunType
)
import getpass

 

Remember to change all lines with CHANGE_ME comments above them in all the blocks below!

 

Log into the Rhino SDK using your FCP Credentials

Your username will be the email address you log into the Rhino FCP platform with. 

print("Logging In")

# CHANGE_ME: MY_USERNAME
my_username = "MY_USERNAME"

session = rh.login(username=my_username, password=getpass.getpass())
print("Logged In")

 

Getting Started: Creating Your Generalized Compute Code Object

To create Generalized Compute Code using the Rhino SDK, you will need to first push a container to your workgroup's ECR. Note the name you use for your container image while pushing; you will need to include it in your code below.  You will also need your ECR workgroup. If you need help locating your ECR Workgroup, please refer to How can I find my ECR Workgroup Repository Name? 

 

Get Supporting FCP Information Needed to Create Your Code Object

At this point, you will need the name of your project, your input Data Schema name, optionally your output Data Schema name, and your ECR URI.  Your ECR URI can be retrieved from your FCP User Profile; for a reminder on how to do this, please refer to How can I find my ECR Workgroup Repository Name?
You can also retrieve each object's UUID by following the instructions here: How do I retrieve a Project's, Collaborator's, Data Schema's, Dataset's, Code Objects's, or Code Run's UUID?

# CHANGE_ME: YOUR_FCP_PROJECT_NAME
project = session.project.get_project_by_name('YOUR_FCP_PROJECT_NAME')

# CHANGE_ME: INPUT_SCHEMA_NAME & Possibly Version Number too
input_schema = session.project.get_data_schema_by_name('INPUT_SCHEMA_NAME', project_uid=project.uid, version=1)

# CHANGE_ME: OUTPUT_SCHEMA_NAME & Possibly Version Number too.
output_schema = session.project.get_data_schema_by_name('OUTPUT_SCHEMA_NAME', project_uid=project.uid, version=1)

# CHANGE_ME: ECR_WORKGROUP
base_ecr_uri = rh.lib.constants.ECRService.PROD_URL + "/ECR_WORKGROUP"

 

Create your Generalized Compute CodeObject using the Container You Just Pushed

During the creation of your CodeObject, you will provide a configuration similar to how a Code Object is created within the GUI. You will give the CodeObject a name, description, input_data_schema_uids, output_data_schema_uids, project_uid, code_object_type, and the config where you will provide the name of the container you just pushed. 

code_object_params = CodeObjectCreateInput(

    # CHANGE_ME: CODE_OBJECT_NAME
    name = "CODE_OBJECT_NAME",
 
    # CHANGE_ME: CODE_OBJECT_DESCRIPTION
    description = "CODE_OBJECT_DESCRIPTION",
 
    input_data_schema_uids = [input_schema.uid],
    # output_schema.uid or None to auto-generate an output schema
    output_data_schema_uids = [output_schema.uid],
    project_uid = project.uid,

    code_object_type = CodeTypes.GENERALIZED_COMPUTE,
    
    # CHANGE_ME: CONTAINER_IMAGE_NAME
    config = {
        "container_image_uri": f"{base_ecr_uri}:CONTAINER_IMAGE_NAME"
    }
)
code_object = session.code.create_code_object(code_object_params)
print(f"Got Code Object '{codeobject.name}' with UID {codeobject.uid}")

 

If you have received an error or run into any issues throughout the process, please check out our community forums, or reach out to support@rhinohealth.com for more assistance.

Was this article helpful?