oracle.oci.oci_data_science_model_provenance – Manage a ModelProvenance resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.0.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install oracle.oci
.
To use it in a playbook, specify: oracle.oci.oci_data_science_model_provenance
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create and update a ModelProvenance resource in Oracle Cloud Infrastructure
For state=present, creates provenance information for the specified model.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
api_user
string
|
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See
config_file_location ). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|
api_user_fingerprint
string
|
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See
config_file_location ). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|
api_user_key_file
string
|
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See
config_file_location ). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided. |
|
api_user_key_pass_phrase
string
|
Passphrase used by the key referenced in
api_user_key_file , if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location ). |
|
auth_purpose
string
|
|
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
|
auth_type
string
|
|
The type of authentication to use for making API requests. By default
auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance. |
cert_bundle
string
|
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
|
|
config_file_location
string
|
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
|
|
config_profile_name
string
|
The profile to load from the config file referenced by
config_file_location . If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location . |
|
force_create
boolean
|
|
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
|
git_branch
string
|
For model reproducibility purposes. Branch of the git repository associated with model training.
This parameter is updatable.
|
|
git_commit
string
|
For model reproducibility purposes. Commit ID of the git repository associated with model training.
This parameter is updatable.
|
|
key_by
list
/ elements=string
|
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
|
|
model_id
string
/ required
|
The OCID of the model.
aliases: id |
|
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
region
string
|
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See
config_file_location ). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions. |
|
repository_url
string
|
For model reproducibility purposes. URL of the git repository associated with model training.
This parameter is updatable.
|
|
script_dir
string
|
For model reproducibility purposes. Path to model artifacts.
This parameter is updatable.
|
|
state
string
|
|
The state of the ModelProvenance.
Use state=present to create or update a ModelProvenance.
|
tenancy
string
|
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See
config_file_location ). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm |
|
training_id
string
|
The OCID of a training session(Job or NotebookSession) in which the model was trained. It is used for model reproducibility purposes.
This parameter is updatable.
|
|
training_script
string
|
For model reproducibility purposes. Path to the python script or notebook in which the model was trained."
This parameter is updatable.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create model_provenance
oci_data_science_model_provenance:
# required
model_id: "ocid1.model.oc1..xxxxxxEXAMPLExxxxxx"
# optional
repository_url: repository_url_example
git_branch: git_branch_example
git_commit: git_commit_example
script_dir: script_dir_example
training_script: training_script_example
training_id: "ocid1.training.oc1..xxxxxxEXAMPLExxxxxx"
- name: Update model_provenance
oci_data_science_model_provenance:
# required
model_id: "ocid1.model.oc1..xxxxxxEXAMPLExxxxxx"
# optional
repository_url: repository_url_example
git_branch: git_branch_example
git_commit: git_commit_example
script_dir: script_dir_example
training_script: training_script_example
training_id: "ocid1.training.oc1..xxxxxxEXAMPLExxxxxx"
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
model_provenance
complex
|
on success |
Details of the ModelProvenance resource acted upon by the current operation
Sample:
{'git_branch': 'git_branch_example', 'git_commit': 'git_commit_example', 'repository_url': 'repository_url_example', 'script_dir': 'script_dir_example', 'training_id': 'ocid1.training.oc1..xxxxxxEXAMPLExxxxxx', 'training_script': 'training_script_example'}
|
|
git_branch
string
|
on success |
For model reproducibility purposes. Branch of the git repository associated with model training.
Sample:
git_branch_example
|
|
git_commit
string
|
on success |
For model reproducibility purposes. Commit ID of the git repository associated with model training.
Sample:
git_commit_example
|
|
repository_url
string
|
on success |
For model reproducibility purposes. URL of the git repository associated with model training.
Sample:
repository_url_example
|
|
script_dir
string
|
on success |
For model reproducibility purposes. Path to model artifacts.
Sample:
script_dir_example
|
|
training_id
string
|
on success |
The OCID of a training session(Job or NotebookSession) in which the model was trained. It is used for model reproducibility purposes.
Sample:
ocid1.training.oc1..xxxxxxEXAMPLExxxxxx
|
|
training_script
string
|
on success |
For model reproducibility purposes. Path to the python script or notebook in which the model was trained."
Sample:
training_script_example
|
Authors¶
Oracle (@oracle)