CreateModelDetails

class oci.ai_document.models.CreateModelDetails(**kwargs)

Bases: object

The information needed to create a new model.

Methods

__init__(**kwargs) Initializes a new CreateModelDetails object with values from keyword arguments.

Attributes

alias_name Gets the alias_name of this CreateModelDetails.
compartment_id [Required] Gets the compartment_id of this CreateModelDetails.
component_models Gets the component_models of this CreateModelDetails.
defined_tags Gets the defined_tags of this CreateModelDetails.
description Gets the description of this CreateModelDetails.
display_name Gets the display_name of this CreateModelDetails.
freeform_tags Gets the freeform_tags of this CreateModelDetails.
is_quick_mode Gets the is_quick_mode of this CreateModelDetails.
max_training_time_in_hours Gets the max_training_time_in_hours of this CreateModelDetails.
model_type [Required] Gets the model_type of this CreateModelDetails.
model_version Gets the model_version of this CreateModelDetails.
project_id [Required] Gets the project_id of this CreateModelDetails.
testing_dataset Gets the testing_dataset of this CreateModelDetails.
training_dataset Gets the training_dataset of this CreateModelDetails.
validation_dataset Gets the validation_dataset of this CreateModelDetails.
__init__(**kwargs)

Initializes a new CreateModelDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • display_name (str) – The value to assign to the display_name property of this CreateModelDetails.
  • description (str) – The value to assign to the description property of this CreateModelDetails.
  • model_version (str) – The value to assign to the model_version property of this CreateModelDetails.
  • model_type (str) – The value to assign to the model_type property of this CreateModelDetails.
  • compartment_id (str) – The value to assign to the compartment_id property of this CreateModelDetails.
  • is_quick_mode (bool) – The value to assign to the is_quick_mode property of this CreateModelDetails.
  • max_training_time_in_hours (float) – The value to assign to the max_training_time_in_hours property of this CreateModelDetails.
  • training_dataset (oci.ai_document.models.Dataset) – The value to assign to the training_dataset property of this CreateModelDetails.
  • testing_dataset (oci.ai_document.models.Dataset) – The value to assign to the testing_dataset property of this CreateModelDetails.
  • validation_dataset (oci.ai_document.models.Dataset) – The value to assign to the validation_dataset property of this CreateModelDetails.
  • component_models (list[oci.ai_document.models.ComponentModel]) – The value to assign to the component_models property of this CreateModelDetails.
  • alias_name (str) – The value to assign to the alias_name property of this CreateModelDetails.
  • project_id (str) – The value to assign to the project_id property of this CreateModelDetails.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateModelDetails.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateModelDetails.
alias_name

Gets the alias_name of this CreateModelDetails. the alias name of the model.

Returns:The alias_name of this CreateModelDetails.
Return type:str
compartment_id

[Required] Gets the compartment_id of this CreateModelDetails. The compartment identifier.

Returns:The compartment_id of this CreateModelDetails.
Return type:str
component_models

Gets the component_models of this CreateModelDetails. The OCID list of active custom Key Value models that need to be composed.

Returns:The component_models of this CreateModelDetails.
Return type:list[oci.ai_document.models.ComponentModel]
defined_tags

Gets the defined_tags of this CreateModelDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:The defined_tags of this CreateModelDetails.
Return type:dict(str, dict(str, object))
description

Gets the description of this CreateModelDetails. An optional description of the model.

Returns:The description of this CreateModelDetails.
Return type:str
display_name

Gets the display_name of this CreateModelDetails. A human-friendly name for the model, which can be changed.

Returns:The display_name of this CreateModelDetails.
Return type:str
freeform_tags

Gets the freeform_tags of this CreateModelDetails. A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {“bar-key”: “value”}

Returns:The freeform_tags of this CreateModelDetails.
Return type:dict(str, str)
is_quick_mode

Gets the is_quick_mode of this CreateModelDetails. Set to true when experimenting with a new model type or dataset, so the model training is quick, with a predefined low number of passes through the training data.

Returns:The is_quick_mode of this CreateModelDetails.
Return type:bool
max_training_time_in_hours

Gets the max_training_time_in_hours of this CreateModelDetails. The maximum model training time in hours, expressed as a decimal fraction.

Returns:The max_training_time_in_hours of this CreateModelDetails.
Return type:float
model_type

[Required] Gets the model_type of this CreateModelDetails. The type of the Document model.

Returns:The model_type of this CreateModelDetails.
Return type:str
model_version

Gets the model_version of this CreateModelDetails. The model version

Returns:The model_version of this CreateModelDetails.
Return type:str
project_id

[Required] Gets the project_id of this CreateModelDetails. The OCID of the project that contains the model.

Returns:The project_id of this CreateModelDetails.
Return type:str
testing_dataset

Gets the testing_dataset of this CreateModelDetails.

Returns:The testing_dataset of this CreateModelDetails.
Return type:oci.ai_document.models.Dataset
training_dataset

Gets the training_dataset of this CreateModelDetails.

Returns:The training_dataset of this CreateModelDetails.
Return type:oci.ai_document.models.Dataset
validation_dataset

Gets the validation_dataset of this CreateModelDetails.

Returns:The validation_dataset of this CreateModelDetails.
Return type:oci.ai_document.models.Dataset