Skip to content

On-premise users: click in-app to access the full platform documentation for your version of DataRobot.

Register custom models

After you create a custom model, you can register it from the model workshop or directly in the Registry. If a registered model already exists to solve a specific business problem, you can add new custom models solving the same problem as registered model versions, providing a model management experience organized by problem type.

Register a model from the model workshop

To register a custom model from the model workshop:

  1. In the Registry, on the Model workshop tab, click the model you want to register, and then click Register model:

  2. On the Register a model page, under Configure the model, the Target and Target type are set based on the model you're registering. Select one of the following registration options:

    • Add a version to an existing registered model: Increment the version number and add a new version to the selected registered model.

    • Create a new registered model: Create a registered model and the first version (V1).

    Then, configure the following fields:

    Field Description
    Registered model name / Registered model Do one of the following:
    • Registered model name: When registering a new model, enter a unique and descriptive name for the new registered model. If you choose a name that exists anywhere within your organization, a warning appears.
    • Registered model: When saving as a version of an existing model, select the existing registered model you want to add a new version to.
    Registered version name Automatically populated with the model name, date, and time. Change or modify the name as necessary.
    Registered model version Assigned automatically. This displays the expected version number of the version (e.g., V1, V2, V3) you create. This is always V1 when you select Register as a new model.
    Optional settings
    Registered version description Enter a description of the business problem this model package solves, or, more generally, describe the model represented by this version.
    Tags Click + Add tag and enter a Key and a Value for each key-value pair you want to tag the model version with. Tags added when registering a new model are applied to V1.

    Note

    If you click Cancel on this page to return to the Registry, you lose the configuration progress on this page.

  3. Click Register Model.

    The model version opens on the Registry > Directory page with a Building status. You can deploy the model at any time.

Register a model from the Registry

To register a custom model from the Registry:

  1. In the Registry, on the Model directory tab, click + Register model (or the button when the registered model or version info panel is open):

    The Register a model panel opens to the External model tab.

  2. Click the DataRobot model tab and then, under Configure the model, select one of the following options:

    • Add a version to an existing registered model: Increments the version number and adds a new version to the selected registered model.

    • Create a new registered model: Creates a registered model and the first version (V1).

    Then, configure the following fields:

    Field Description
    Custom model Select the custom model you want to register from the model workshop.
    Custom model version Select the version of the custom model to register.
    Registered model name / Registered model Do one of the following:
    • Registered model name: When registering a new model, enter a unique and descriptive name for the new registered model. If you choose a name that exists anywhere within your organization, a warning appears.
    • Registered model: When saving as a version of an existing model, select the existing registered model you want to add a new version to.
    Registered version name Automatically populated with the model name, date, and time. Change or modify the name as necessary.
    Registered model version Assigned automatically. This displays the expected version number of the version (e.g., V1, V2, V3) you create. This is always V1 when you select Register as a new model.
    Optional settings
    Registered version description Enter a description of the business problem this model package solves, or, more generally, describe the model represented by this version.
    Tags Click + Add tag and enter a Key and a Value for each key-value pair you want to tag the model version with. Tags added when registering a new model are applied to V1.

    Note

    If you click Cancel on this page to return to the Registry, you lose the configuration progress on this page.

  3. Click Register Model.

    The model version opens on the Registry > Directory page with a Building status. You can deploy the model at any time.


Updated November 7, 2023
Back to top