Working with model registries

Procedure

1. From the OpenShift AI dashboard, click AI hub → Registry.
2. From the Model registry drop-down list, select the model registry that you want to register a model version in.

3. In the Model name column, click the name of the model that you want to register a new version of.

   The details page for the model opens.

4. Click the Versions tab, and then click Register new version.

5. In the Version details section, enter details to apply to this version of the model:

   1. In the Version name field, enter a name for the model version.
   2. Optional: In the Version description field, enter a description for this version of the model.
   3. In the Source model format field, enter the name of the model format, for example, ONNX.
   4. In the Source model format version field, enter the version of the model format.

6. In the Model location section, specify the location of the model by providing either object storage details, or a URI.

   1. To provide object storage details, ensure that the Object storage radio button is selected.

      1. To autofill the details of an existing connection:

         1. Click Autofill from connection.
         2. In the Autofill from connection dialog that opens, from the Project drop-down list, select the project that contains the connection.

         3. From the Connection name drop-down list, select the connection that you want to use.

            This list contains only object storage types which contain a bucket.

         4. Click Autofill.

      2. Alternatively, manually fill out your object storage details:

         1. In the Endpoint field, enter the endpoint of your S3-compatible object storage bucket.
         2. In the Bucket field, enter the name of your S3-compatible object storage bucket.
         3. In the Region field, enter the region of your S3-compatible object storage account.
         4. In the Path field, enter a path to a model or folder. This path cannot point to a root folder.

   2. To provide a URI, ensure that the URI radio button is selected.

      1. In the URI field, enter the URI for the model.

         Important

         Deployment of models that are registered by using a URI is currently supported for public OCI repositories only.

7. Click Register new version.

Procedure

1. From the OpenShift AI dashboard, click AI hub → Registry.
2. From the Model registry drop-down list, select the model registry that contains the model that you want to view.

3. The Model registry page provides a high-level view of registered models, including the model name, latest version, deployments, labels, last modified timestamp, and owner of each model.

   Models are sorted by their Last modified timestamp by default.

4. Use the search bar to find a model in the list. You can filter with a keyword by default by entering a model name, description, or label. Alternatively, click the search bar drop-down list and select Owner to filter by entering a model owner.

   Searching by keyword performs a search across the name, description, and labels of registered models and their versions.

5. Click the name of a model to view the details page for the model:

   1. On the Overview tab, you can view model metadata such as labels, description, owner, model ID, last modified and created timestamps, and custom properties, along with latest versions and deployments.
   2. On the Versions tab, you can view the registered versions of the model.
   3. On the Deployments tab, you can view deployments initiated from the model registry for this model.

Procedure

1. From the OpenShift AI dashboard, click AI hub → Registry.
2. From the Model registry drop-down list, select the model registry that contains the model version that you want to view.
3. Click the name of a model to view Overview tab on the model details page, which includes the latest model versions and deployments.

4. On the Versions tab, you can view the registered versions of the model.

   Versions are sorted by their Last modified timestamp by default.

5. Use the search bar to find a version in the list. You can filter with a keyword by default by entering a model name, description, or label. Alternatively, click the search bar drop-down list and select Author to filter by entering a model owner.

   Searching by keyword performs a search across the name, description, and labels of registered models and their versions.

6. Click the name of a version to view the version details page.

7. On the Details tab, you can view the Version details metadata, such as labels, description, custom properties, version ID, author, and last modified and registered timestamps. This also includes where the model is registered from, model location, and model format information.

   You can also click Model details to view non-version metadata, such as labels, description, owner, model ID, last modified and created timestamps, and custom properties.

8. On the Deployments tab, you can view deployments initiated from the model registry for this version.

   1. Click the name of a deployment to open its metrics page.

      For information about model metrics, see Viewing performance metrics for a deployed model.

Procedure

1. From the OpenShift AI dashboard, click AI hub → Registry.
2. From the Model registry drop-down list, select the model registry that contains the model that you want to edit.
3. The Model registry page provides a high-level view of registered models, including the model name, latest version, deployments, labels, last modified timestamp, and owner of each model.
4. Click the name of a model to view the model details page.

5. On the Overview tab, you can edit metadata for the model.

   1. In the Labels section, click Edit to edit the labels of the model, for example, text-to-text.
   2. In the Description section, click Edit to edit the description of the model.

   3. In the Properties section, click Add property to add a new property to the model, for example, Key: license, Value: apache.

      Tip

      If you enter any property value as a URL, this is displayed as a clickable link in the Properties section, for example: https://www.apache.org/licenses/LICENSE-2.0.

      1. To edit an existing property, click the action menu (⋮) beside the property, and then click Edit.
      2. To delete a property, click the action menu (⋮) beside the property, and then click Delete.

Procedure

1. From the OpenShift AI dashboard, click AI hub → Registry.
2. From the Model registry drop-down list, select the model registry that contains the model version that you want to edit.
3. Click the name of a model to view the model details page.
4. Click the Versions tab to view the available model versions.
5. Click a version name to view the version details page.

6. In the Version details section, you can edit the version metadata.

   1. In the Labels section, click Edit to edit the labels of the version, for example, text-to-text.
   2. In the Description section, click Edit to edit the description of the version.

   3. In the Properties section, click Add property to add a new property to the version, for example, Key: license, Value: apache.

      Tip

      If you enter any property value as a URL, this is displayed as a clickable link in the Properties section, for example: https://www.apache.org/licenses/LICENSE-2.0.

      1. To edit an existing property, click the action menu (⋮) beside the property, and then click Edit.
      2. To delete a property, click the action menu (⋮) beside the property, and then click Delete.
   4. In the Model format section, click Edit to edit the format of the model version, for example, ONNX.
   5. In the Model format version section, click Edit to edit the format version of the model version.

Procedure

1. From the OpenShift AI dashboard, click AI hub → Registry.
2. From the Model registry list, select the model registry from which you want to deploy a model version.

3. In the Model name column, click the name of the model that contains the version that you want to deploy.

   The details page for the model version opens.

4. Click the action menu (⋮) beside the model version that you want to deploy.
5. Click Deploy for the model version.

6. In the Deploy model dialog, configure properties for deploying the model:

   1. From the Project list, select a target project.

      When you select a project, OpenShift AI scans through the connections to that project and checks if any match the connections that the model was registered with.

      If there is a single matching connection, this is autoselected. If there are multiple matching connections, these are displayed next in the Connection list.

      If there are no matching connections, you can go straight to the deployment wizard, without selecting a connection, and the model location data will be autofilled as a new connection.

   2. When there are multiple matching connections, from the Connection list, select the connection that you want to use when deploying the model.

      The deployment wizard is autofilled with the details for your selected connection. If you selected a connection or one was autoselected, you can change the connection or create a new one in the next steps.

   3. Click Deploy.

      This displays the deployment wizard.

7. On the Model details page, provide information about the model:

   1. From the Model location list, specify where your model is stored and complete the appropriate details for your connection. For a matching connection selected in the Deploy model dialog, the details are autofilled. Alternatively, you can create a new connection.

      For more information about connections, see Adding a connection to your project.

   2. Optional: In the Model deployment name field, enter a unique name for your model deployment. This field is autofilled with a value that contains the model name by default.

      This will be the name of the inference service that is created when the model is deployed.

8. Click Next.
9. On the Model deployment and Advanced settings pages, configure the remaining properties for deploying your model, as described in Deploying models on the model serving platform.
10. On the Review page, review the settings that you have selected before deploying the model.
11. Click Deploy.

Procedure

1. From the OpenShift AI dashboard, click AI hub → Registry.
2. From the Model registry drop-down list, select the model registry that contains the deployment that you want to delete.

3. Click the name of a model to view more details.

   The details page for the model opens.

4. Click the name of the model version with the deployment that you want to delete.

   The details page for the model version opens.

5. Click Deployments.

6. To delete a deployment, click the action menu (⋮) beside the deployment, and then click Delete.

   The Delete deployed model? dialog opens.

7. Enter the name of the model deployment in the text field to confirm that you intend to delete it.
8. Click Delete deployed model.

Procedure

1. From the OpenShift AI dashboard, click AI hub → Registry.
2. From the Model registry drop-down list, select the model registry that you want to archive a model in.
3. Click the action menu (⋮) beside the model that you want to archive.
4. Click Archive model.
5. In the Archive model? dialog that is displayed, enter the name of the model in the text field to confirm that you intend to archive it.
6. Click Archive.

Procedure

1. From the OpenShift AI dashboard, click AI hub → Registry.
2. From the Model registry drop-down list, select the model registry that you want to archive a model in.

3. In the Model name column, click the name of the model that contains the version that you want to archive.

   The details page for the model version opens.

4. Click the action menu (⋮) beside the version that you want to archive.
5. Click Archive model version.
6. In the Archive version? dialog that opens, enter the name of the model version in the text field to confirm that you intend to archive it.
7. Click Archive.

Procedure

1. From the OpenShift AI dashboard, click AI hub → Registry.
2. From the Model registry drop-down list, select the model registry that you want to restore a model in.

3. Click the action menu (⋮) beside the Register model button, and then click View archived models.

   The archived models page for the model registry opens.

4. Click the action menu (⋮) beside the model that you want to restore.
5. Click Restore model.
6. In the Restore model? dialog that is displayed, click Restore.

Procedure

1. From the OpenShift AI dashboard, click AI hub → Registry.
2. From the Model registry drop-down list, select the model registry that you want to restore a model version in.

3. In the Model name column, click the name of the model that contains the version that you want to restore.

   The details page for the model version opens.

4. Click the action menu (⋮) beside the Register new version button, and then click View archived versions.

   The archived versions page for the model opens.

5. Click the action menu (⋮) beside the version that you want to restore.
6. Click Restore version.

7. In the Restore version? dialog that opens, click Restore.

   The details page for the version opens.