create-model-provenance

Description

Creates provenance information for the specified model.

Usage

oci data-science model create-model-provenance [OPTIONS]

Required Parameters

--model-id [text]

The OCID of the model.

Optional Parameters

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--git-branch [text]

For model reproducibility purposes. Branch of the git repository associated with model training.

--git-commit [text]

For model reproducibility purposes. Commit ID of the git repository associated with model training.

--repository-url [text]

For model reproducibility purposes. URL of the git repository associated with model training.

--script-dir [text]

For model reproducibility purposes. Path to model artifacts.

--training-id [text]

The OCID of a training session(Job or NotebookSession) in which the model was trained. It is used for model reproducibility purposes.

--training-script [text]

For model reproducibility purposes. Path to the python script or notebook in which the model was trained.”

Examples

Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-science/project/create.html#cmdoption-compartment-id

    project_id=$(oci data-science project create --compartment-id $compartment_id --query data.id --raw-output)

    model_id=$(oci data-science model create --compartment-id $compartment_id --project-id $project_id --query data.id --raw-output)

    oci data-science model create-model-provenance --model-id $model_id