oracle.oci.oci_data_science_model – Manage a Model resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 5.3.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.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a Model resource in Oracle Cloud Infrastructure

  • For state=present, creates a new model.

  • This resource has the following action operations in the oracle.oci.oci_data_science_model_actions module: activate, change_compartment, deactivate, export_model_artifact, import_model_artifact.

Requirements

The below requirements are needed on the host that executes this module.

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
    Choices:
  • service_principal
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
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
  • security_token
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.
compartment_id
string
The OCID of the compartment to create the model in.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
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.
custom_metadata_list
list / elements=dictionary
An array of custom metadata details for the model.
This parameter is updatable.
category
string
Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,other".
description
string
Description of model metadata
key
string
Key of the model Metadata. The key can either be user defined or OCI defined. List of OCI defined keys: * useCaseType * libraryName * libraryVersion * estimatorClass * hyperParameters * testartifactresults
value
string
Allowed values for useCaseType: binary_classification, regression, multinomial_classification, clustering, recommender, dimensionality_reduction/representation, time_series_forecasting, anomaly_detection, topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other
Allowed values for libraryName: scikit-learn, xgboost, tensorflow, pytorch, mxnet, keras, lightGBM, pymc3, pyOD, spacy, prophet, sktime, statsmodels, cuml, oracle_automl, h2o, transformers, nltk, emcee, pystan, bert, gensim, flair, word2vec, ensemble, other
defined_metadata_list
list / elements=dictionary
An array of defined metadata details for the model.
This parameter is updatable.
category
string
Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,other".
description
string
Description of model metadata
key
string
Key of the model Metadata. The key can either be user defined or OCI defined. List of OCI defined keys: * useCaseType * libraryName * libraryVersion * estimatorClass * hyperParameters * testartifactresults
value
string
Allowed values for useCaseType: binary_classification, regression, multinomial_classification, clustering, recommender, dimensionality_reduction/representation, time_series_forecasting, anomaly_detection, topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other
Allowed values for libraryName: scikit-learn, xgboost, tensorflow, pytorch, mxnet, keras, lightGBM, pymc3, pyOD, spacy, prophet, sktime, statsmodels, cuml, oracle_automl, h2o, transformers, nltk, emcee, pystan, bert, gensim, flair, word2vec, ensemble, other
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
description
string
A short description of the model.
This parameter is updatable.
display_name
string
A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. Example: `My Model`
Required for create, update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: name
force_create
boolean
    Choices:
  • no ←
  • yes
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.
freeform_tags
dictionary
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: `{"Department": "Finance"}`
This parameter is updatable.
input_schema
string
Input schema file content in String format
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
The OCID of the model.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
model_version_set_id
string
The OCID of the model version set that the model is associated to.
This parameter is updatable.
output_schema
string
Output schema file content in String format
project_id
string
The OCID of the project to associate with the model.
Required for create using state=present.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
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.
state
string
    Choices:
  • present ←
  • absent
The state of the Model.
Use state=present to create or update a Model.
Use state=absent to delete a Model.
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
version_label
string
The version label can add an additional description of the lifecycle state of the model or the application using/training the model.
This parameter is updatable.
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create model
  oci_data_science_model:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    project_id: "ocid1.project.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    input_schema: input_schema_example
    output_schema: output_schema_example
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    custom_metadata_list:
    - # optional
      key: key_example
      value: value_example
      description: description_example
      category: category_example
    defined_metadata_list:
    - # optional
      key: key_example
      value: value_example
      description: description_example
      category: category_example
    model_version_set_id: "ocid1.modelversionset.oc1..xxxxxxEXAMPLExxxxxx"
    version_label: version_label_example

- name: Update model
  oci_data_science_model:
    # required
    model_id: "ocid1.model.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    custom_metadata_list:
    - # optional
      key: key_example
      value: value_example
      description: description_example
      category: category_example
    defined_metadata_list:
    - # optional
      key: key_example
      value: value_example
      description: description_example
      category: category_example
    model_version_set_id: "ocid1.modelversionset.oc1..xxxxxxEXAMPLExxxxxx"
    version_label: version_label_example

- name: Update model using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_data_science_model:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    custom_metadata_list:
    - # optional
      key: key_example
      value: value_example
      description: description_example
      category: category_example
    defined_metadata_list:
    - # optional
      key: key_example
      value: value_example
      description: description_example
      category: category_example
    model_version_set_id: "ocid1.modelversionset.oc1..xxxxxxEXAMPLExxxxxx"
    version_label: version_label_example

- name: Delete model
  oci_data_science_model:
    # required
    model_id: "ocid1.model.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete model using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_data_science_model:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
model
complex
on success
Details of the Model resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'created_by': 'created_by_example', 'custom_metadata_list': [{'category': 'category_example', 'description': 'description_example', 'key': 'key_example', 'value': 'value_example'}], 'defined_metadata_list': [{'category': 'category_example', 'description': 'description_example', 'key': 'key_example', 'value': 'value_example'}], 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'input_schema': 'input_schema_example', 'lifecycle_state': 'ACTIVE', 'model_version_set_id': 'ocid1.modelversionset.oc1..xxxxxxEXAMPLExxxxxx', 'model_version_set_name': 'model_version_set_name_example', 'output_schema': 'output_schema_example', 'project_id': 'ocid1.project.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'version_id': 56, 'version_label': 'version_label_example'}
 
compartment_id
string
on success
The OCID of the model's compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
created_by
string
on success
The OCID of the user who created the model.

Sample:
created_by_example
 
custom_metadata_list
complex
on success
An array of custom metadata details for the model.
   
category
string
on success
Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,other".

Sample:
category_example
   
description
string
on success
Description of model metadata

Sample:
description_example
   
key
string
on success
Key of the model Metadata. The key can either be user defined or OCI defined. List of OCI defined keys: * useCaseType * libraryName * libraryVersion * estimatorClass * hyperParameters * testartifactresults

Sample:
key_example
   
value
string
on success
Allowed values for useCaseType: binary_classification, regression, multinomial_classification, clustering, recommender, dimensionality_reduction/representation, time_series_forecasting, anomaly_detection, topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other
Allowed values for libraryName: scikit-learn, xgboost, tensorflow, pytorch, mxnet, keras, lightGBM, pymc3, pyOD, spacy, prophet, sktime, statsmodels, cuml, oracle_automl, h2o, transformers, nltk, emcee, pystan, bert, gensim, flair, word2vec, ensemble, other

Sample:
value_example
 
defined_metadata_list
complex
on success
An array of defined metadata details for the model.
   
category
string
on success
Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values "Performance,Training Profile,Training and Validation Datasets,Training Environment,other".

Sample:
category_example
   
description
string
on success
Description of model metadata

Sample:
description_example
   
key
string
on success
Key of the model Metadata. The key can either be user defined or OCI defined. List of OCI defined keys: * useCaseType * libraryName * libraryVersion * estimatorClass * hyperParameters * testartifactresults

Sample:
key_example
   
value
string
on success
Allowed values for useCaseType: binary_classification, regression, multinomial_classification, clustering, recommender, dimensionality_reduction/representation, time_series_forecasting, anomaly_detection, topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other
Allowed values for libraryName: scikit-learn, xgboost, tensorflow, pytorch, mxnet, keras, lightGBM, pymc3, pyOD, spacy, prophet, sktime, statsmodels, cuml, oracle_automl, h2o, transformers, nltk, emcee, pystan, bert, gensim, flair, word2vec, ensemble, other

Sample:
value_example
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
description
string
on success
A short description of the model.

Sample:
description_example
 
display_name
string
on success
A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the model.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
input_schema
string
on success
Input schema file content in String format

Sample:
input_schema_example
 
lifecycle_state
string
on success
The state of the model.

Sample:
ACTIVE
 
model_version_set_id
string
on success
The OCID of the model version set that the model is associated to.

Sample:
ocid1.modelversionset.oc1..xxxxxxEXAMPLExxxxxx
 
model_version_set_name
string
on success
The name of the model version set that the model is associated to.

Sample:
model_version_set_name_example
 
output_schema
string
on success
Output schema file content in String format

Sample:
output_schema_example
 
project_id
string
on success
The OCID of the project associated with the model.

Sample:
ocid1.project.oc1..xxxxxxEXAMPLExxxxxx
 
time_created
string
on success
The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z

Sample:
2013-10-20T19:20:30+01:00
 
version_id
integer
on success
Unique identifier assigned to each version of the model.

Sample:
56
 
version_label
string
on success
The version label can add an additional description of the lifecycle state of the model or the application using and training the model.

Sample:
version_label_example


Authors

  • Oracle (@oracle)