Register DataRobot models¶
The Model Registry is an organizational hub for the variety of models used in DataRobot. Models are registered as deployment-ready model packages; the registry lists each package available for use.
To add a DataRobot model as a registered model or version:
-
On the Leaderboard, select the model to use for generating predictions. DataRobot recommends a model with the Recommended for Deployment and Prepared for Deployment badges. The model preparation process runs Feature Impact, retrains the model on a reduced feature list, and trains on a higher sample size, followed by the entire sample (latest data for date/time partitioned projects).
Important
The Deploy tab behaves differently in environments without a dedicated prediction server, as described in the section on shared modeling workers.
-
Click Predict > Deploy. If the Leaderboard model doesn't have the Prepare for Deployment badge, DataRobot recommends you click Prepare for Deployment to run the model preparation process for that model.
-
Under Deploy model, click Register to deploy.
-
In the Register new model dialog box, provide the following model information:
Field Description Register model Select one of the following: - Register new model: Create a new registered model. This creates the first version (V1).
- Save as a new version to existing model: Create a version of an existing registered model. This increments the version number and adds a new version to the registered model.
Registered model name / Registered Model Do one of the following: - Registered model name: Enter a unique and descriptive name for the new registered model. If you choose a name that exists anywhere within your organization, the Model registration failed warning appears.
- Registered Model: Select the existing registered model you want to add a new version to.
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 a new model. Prediction threshold For binary classification models. Enter the value a prediction score must exceed to be assigned to the positive class. The default value is 0.5
. For more information, see Prediction thresholds.Optional settings Version description Describe the business problem this model package solves, or, more generally, describe the model represented by this version. Tags Click + Add item and enter a Key and a Value for each key-value pair you want to tag the model version with. Tags do not apply to the registered model, just the versions within. Tags added when registering a new model are applied to V1. Include prediction intervals For time series models. Enable the computation of a model's time series prediction intervals (from 1 to 100). Time series prediction intervals may take a long time to compute, depending on the number of series in the dataset, the number of features, the blueprint, etc. Consider if intervals are required in your deployment before enabling this setting. For more information see, the prediction intervals consideration. Binary classification prediction thresholds
If you set the prediction threshold before the deployment preparation process, the value does not persist. When deploying the prepared model, if you want it to use a value other than the default, set the value after the model has the Prepared for Deployment badge.
Time series prediction intervals consideration
When you deploy a time series model package with prediction intervals, the Predictions > Prediction Intervals tab is available in the deployment. For deployed model packages built without computing intervals, the deployment's Predictions > Prediction Intervals tab is hidden; however, older time series deployments without computed prediction intervals may display the Prediction Intervals tab if they were deployed prior to August 2022.
-
Click Add to registry. The model opens on the Model Registry > Registered Models tab. You can later deploy the model from the Model Registry.