@Generated(value="OracleSDKGenerator",
comments="API Version: 20221109")
public final class Model
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Machine-learned Model.
Note: Objects should always be created or deserialized using the Model.Builder. This model
distinguishes fields that are null because they are unset from fields that are explicitly
set to null. This is done in the setter methods of the Model.Builder, which maintain a
set of all explicitly set fields called Model.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
Model.Builder |
static class |
Model.LifecycleState
The current state of the model.
|
static class |
Model.ModelType
The type of the Document model.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
Model(String id,
String displayName,
String description,
String compartmentId,
Model.ModelType modelType,
String tenancyId,
String aliasName,
List<String> labels,
Boolean isQuickMode,
Double maxTrainingTimeInHours,
Double trainedTimeInHours,
Dataset trainingDataset,
Dataset testingDataset,
Dataset validationDataset,
List<ComponentModel> componentModels,
Boolean isComposedModel,
String modelVersion,
String projectId,
Date timeCreated,
Date timeUpdated,
Model.LifecycleState lifecycleState,
String lifecycleDetails,
ModelMetrics metrics,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> systemTags,
List<ResourceLock> locks)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Model.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getAliasName()
the alias name of the model.
|
String |
getCompartmentId()
The compartment identifier.
|
List<ComponentModel> |
getComponentModels()
The OCID
collection of active custom Key Value models that need to be composed.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDescription()
An optional description of the model.
|
String |
getDisplayName()
A human-friendly name for the model, which can be changed.
|
Map<String,String> |
getFreeformTags()
A simple key-value pair that is applied without any predefined name, type, or scope.
|
String |
getId()
A unique identifier that is immutable after creation.
|
Boolean |
getIsComposedModel()
Set to true when the model is created by using multiple key value extraction models.
|
Boolean |
getIsQuickMode()
Set to true when experimenting with a new model type or dataset, so model training is quick,
with a predefined low number of passes through the training data.
|
List<String> |
getLabels()
The collection of labels used to train the custom model.
|
String |
getLifecycleDetails()
A message describing the current state in more detail, that can provide actionable
information if training failed.
|
Model.LifecycleState |
getLifecycleState()
The current state of the model.
|
List<ResourceLock> |
getLocks()
Locks associated with this resource.
|
Double |
getMaxTrainingTimeInHours()
The maximum model training time in hours, expressed as a decimal fraction.
|
ModelMetrics |
getMetrics() |
Model.ModelType |
getModelType()
The type of the Document model.
|
String |
getModelVersion()
The version of the model.
|
String |
getProjectId()
The OCID of
the project that contains the model.
|
Map<String,Map<String,Object>> |
getSystemTags()
Usage of system tag keys.
|
String |
getTenancyId()
The tenancy id of the model.
|
Dataset |
getTestingDataset() |
Date |
getTimeCreated()
When the model was created, as an RFC3339 datetime string.
|
Date |
getTimeUpdated()
When the model was updated, as an RFC3339 datetime string.
|
Double |
getTrainedTimeInHours()
The total hours actually used for model training.
|
Dataset |
getTrainingDataset() |
Dataset |
getValidationDataset() |
int |
hashCode() |
Model.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","displayName","description","compartmentId","modelType","tenancyId","aliasName","labels","isQuickMode","maxTrainingTimeInHours","trainedTimeInHours","trainingDataset","testingDataset","validationDataset","componentModels","isComposedModel","modelVersion","projectId","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","metrics","freeformTags","definedTags","systemTags","locks"}) public Model(String id, String displayName, String description, String compartmentId, Model.ModelType modelType, String tenancyId, String aliasName, List<String> labels, Boolean isQuickMode, Double maxTrainingTimeInHours, Double trainedTimeInHours, Dataset trainingDataset, Dataset testingDataset, Dataset validationDataset, List<ComponentModel> componentModels, Boolean isComposedModel, String modelVersion, String projectId, Date timeCreated, Date timeUpdated, Model.LifecycleState lifecycleState, String lifecycleDetails, ModelMetrics metrics, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags, List<ResourceLock> locks)
public static Model.Builder builder()
Create a new builder.
public Model.Builder toBuilder()
public String getId()
A unique identifier that is immutable after creation.
public String getDisplayName()
A human-friendly name for the model, which can be changed.
public String getDescription()
An optional description of the model.
public String getCompartmentId()
The compartment identifier.
public Model.ModelType getModelType()
The type of the Document model.
public String getTenancyId()
The tenancy id of the model.
public String getAliasName()
the alias name of the model.
public List<String> getLabels()
The collection of labels used to train the custom model.
public Boolean getIsQuickMode()
Set to true when experimenting with a new model type or dataset, so model training is quick, with a predefined low number of passes through the training data.
public Double getMaxTrainingTimeInHours()
The maximum model training time in hours, expressed as a decimal fraction.
public Double getTrainedTimeInHours()
The total hours actually used for model training.
public Dataset getTrainingDataset()
public Dataset getTestingDataset()
public Dataset getValidationDataset()
public List<ComponentModel> getComponentModels()
The OCID collection of active custom Key Value models that need to be composed.
public Boolean getIsComposedModel()
Set to true when the model is created by using multiple key value extraction models.
public String getModelVersion()
The version of the model.
public String getProjectId()
The OCID of the project that contains the model.
public Date getTimeCreated()
When the model was created, as an RFC3339 datetime string.
public Date getTimeUpdated()
When the model was updated, as an RFC3339 datetime string.
public Model.LifecycleState getLifecycleState()
The current state of the model.
public String getLifecycleDetails()
A message describing the current state in more detail, that can provide actionable information if training failed.
public ModelMetrics getMetrics()
public Map<String,String> getFreeformTags()
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"}
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. For
example: {"foo-namespace": {"bar-key": "value"}}
public Map<String,Map<String,Object>> getSystemTags()
Usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}
public List<ResourceLock> getLocks()
Locks associated with this resource.
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.