Editing a Model
You can edit (update) some Data Science model options.
If you added metadata to a model, you can edit the provenance and taxonomy. You can't edit the input and output schemas.
You can edit the model name and description, all other options are unchangeable. You can change a model by loading it back into a notebook session, making changes, and then saving the model as a new model.
-
From the models page, select the name of the model. If you need help finding
the list of models, see Listing Models.
The model details page opens.
- Select Edit.
- (Optional) Change the name, description, or version label.
- (Optional)
In the Model provenance box, select
Select.
- Select Notebook session or Job run depending on where you want to store the taxonomy documentation.
-
Find the notebook session or job run that the model was trained with by
using one of the following options:
- Select a project:
-
Select the name of the project to use in the selected compartment.
The selected compartment applies to both the project and the notebook session or job run, and both must be in the same compartment. If not, then use the OCID search instead.
You can change the compartment for both the project and notebook session or job run.
The name of the project to use in the selected compartment.
Select the notebook session or job run that the model was trained with.
- OCID search:
-
If the notebook session or job run is in a different compartment than the project, then enter the notebook session or job run OCID that you trained the model in.
- Select the notebook session or job run that the model was trained with.
- (Optional)
Select Show advanced options to identify Git and
model training information.
Enter or select any of the following values:
- Git repository URL
-
The URL of the remote Git repository.
- Git commit
-
The commit ID of the Git repository.
- Git branch
-
The name of the branch.
- Local model directory
-
The directory path where the model artifact was temporarily stored. This could be a path in a notebook session or a local computer directory for example.
- Model training script
-
The name of the Python script or notebook session that the model was trained with.
Tip
You can also populate model provenance metadata when you save a model to the model catalog using the OCI SDKs or the CLI.
- Select Select.
- (Optional)
In the Model taxonomy box, select
Select to specify what the model does, machine
learning framework, hyperparameters, to create custom metadata to document the
model, or to upload an artifact..
Important
The maximum allowed size for all the model metadata is 32000 bytes. The size is a combination of the preset model taxonomy and the custom attributes.
-
In the Model taxonomy section, add preset labels
as follows:
Enter or select the following:
Model taxonomy- Use case
-
The type of machine learning use case to use.
- Model framework
-
The Python library you used to train the model.
- Model framework version
-
The version of the machine learning framework. This is a free text value. For example, the value could be 2.3.
- Model algorithm or model estimator object
-
The algorithm used or model instance class. This is a free text value. For example,
sklearn.ensemble.RandomForestRegressorcould be the value. - Model hyperparameters
-
The hyperparameters of the model in JSON format.
- Artifact test results
-
The JSON output of the introspection test results run on the client side. These tests are included in the model artifact boilerplate code. You can run them optionally before saving the model in the model catalog.
Create custom label and value attribute pairs- Label
-
The key label of your custom metadata
- Value
-
The value attached to the key
- Category
-
(Optional) The category of the metadata from many choices including:
-
performance
-
training profile
-
training and validation datasets
-
training environment
-
other
You can use the category to group and filter custom metadata to display in the Console. This is useful when you have many custom metadata that you want to track.
-
- Description
-
(Optional) Enter unique description of the custom metadata.
Upload an artifact- For the model in question, for the taxonomy attributes, License, Readme, Deployment Configuration, and FineTune Configuration, or for custom model attributes, select Upload artifact from the Actions menu.
- Upload an artifact file by selecting to drop the file or by selecting the file.
- Select Upload.
Download an artifact- For the model in question, select Download artifact from the Actions menu.
Delete an artifact- For the model in question, select Delete artifact from the Actions menu.
- Select Delete.
- Select Select.
-
In the Model taxonomy section, add preset labels
as follows:
- (Optional) Select Show Advanced Options to change tags.
- (Optional) In the Tags section, add one or more tags to the <resourceType>. If you have permissions to create a resource, then you also have permissions to apply free-form tags to that resource. To apply a defined tag, you must have permissions to use the tag namespace. For more information about tagging, see Resource Tags. If you're not sure whether to apply tags, skip this option or ask an administrator. You can apply tags later.
- Select Save changes.
-
From the models page, select the name of the model. If you need help finding
the list of models, see Listing Models.
Use the oci data-science model update command and required parameters to edit (update) a model:
Commandoci data-science model update --model-id<model-id>... [OPTIONS]For a complete list of flags and variable options for CLI commands, see the CLI Command Reference.
Use the UpdateModel operation to edit (update) a model.