azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.m...

246 строки
20 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.machinelearning.models.TrainingSettings"
fullName: "com.azure.resourcemanager.machinelearning.models.TrainingSettings"
name: "TrainingSettings"
nameWithType: "TrainingSettings"
summary: "Training related configuration."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **TrainingSettings**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.machinelearning.models.TrainingSettings?alt=com.azure.resourcemanager.machinelearning.models.TrainingSettings&text=TrainingSettings\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.TrainingSettings()"
fullName: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.TrainingSettings()"
name: "TrainingSettings()"
nameWithType: "TrainingSettings.TrainingSettings()"
summary: "Creates an instance of Training<wbr>Settings class."
syntax: "public TrainingSettings()"
desc: "Creates an instance of TrainingSettings class."
methods:
- uid: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.enableDnnTraining()"
fullName: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.enableDnnTraining()"
name: "enableDnnTraining()"
nameWithType: "TrainingSettings.enableDnnTraining()"
summary: "Get the enable<wbr>Dnn<wbr>Training property: Enable recommendation of DNN models."
syntax: "public Boolean enableDnnTraining()"
desc: "Get the enableDnnTraining property: Enable recommendation of DNN models."
returns:
description: "the enableDnnTraining value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.enableModelExplainability()"
fullName: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.enableModelExplainability()"
name: "enableModelExplainability()"
nameWithType: "TrainingSettings.enableModelExplainability()"
summary: "Get the enable<wbr>Model<wbr>Explainability property: Flag to turn on explainability on best model."
syntax: "public Boolean enableModelExplainability()"
desc: "Get the enableModelExplainability property: Flag to turn on explainability on best model."
returns:
description: "the enableModelExplainability value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.enableOnnxCompatibleModels()"
fullName: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.enableOnnxCompatibleModels()"
name: "enableOnnxCompatibleModels()"
nameWithType: "TrainingSettings.enableOnnxCompatibleModels()"
summary: "Get the enable<wbr>Onnx<wbr>Compatible<wbr>Models property: Flag for enabling onnx compatible models."
syntax: "public Boolean enableOnnxCompatibleModels()"
desc: "Get the enableOnnxCompatibleModels property: Flag for enabling onnx compatible models."
returns:
description: "the enableOnnxCompatibleModels value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.enableStackEnsemble()"
fullName: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.enableStackEnsemble()"
name: "enableStackEnsemble()"
nameWithType: "TrainingSettings.enableStackEnsemble()"
summary: "Get the enable<wbr>Stack<wbr>Ensemble property: Enable stack ensemble run."
syntax: "public Boolean enableStackEnsemble()"
desc: "Get the enableStackEnsemble property: Enable stack ensemble run."
returns:
description: "the enableStackEnsemble value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.enableVoteEnsemble()"
fullName: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.enableVoteEnsemble()"
name: "enableVoteEnsemble()"
nameWithType: "TrainingSettings.enableVoteEnsemble()"
summary: "Get the enable<wbr>Vote<wbr>Ensemble property: Enable voting ensemble run."
syntax: "public Boolean enableVoteEnsemble()"
desc: "Get the enableVoteEnsemble property: Enable voting ensemble run."
returns:
description: "the enableVoteEnsemble value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.ensembleModelDownloadTimeout()"
fullName: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.ensembleModelDownloadTimeout()"
name: "ensembleModelDownloadTimeout()"
nameWithType: "TrainingSettings.ensembleModelDownloadTimeout()"
summary: "Get the ensemble<wbr>Model<wbr>Download<wbr>Timeout property: During Voting<wbr>Ensemble and Stack<wbr>Ensemble model generation, multiple fitted models from the previous child runs are downloaded."
syntax: "public Duration ensembleModelDownloadTimeout()"
desc: "Get the ensembleModelDownloadTimeout property: During VotingEnsemble and StackEnsemble model generation, multiple fitted models from the previous child runs are downloaded. Configure this parameter with a higher value than 300 secs, if more time is needed."
returns:
description: "the ensembleModelDownloadTimeout value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
- uid: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "TrainingSettings.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Training<wbr>Settings from the Json<wbr>Reader."
modifiers:
- "static"
parameters:
- description: "The JsonReader being read."
name: "jsonReader"
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static TrainingSettings fromJson(JsonReader jsonReader)"
exceptions:
- description: "If an error occurs while reading the TrainingSettings."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Reads an instance of TrainingSettings from the JsonReader."
returns:
description: "An instance of TrainingSettings if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
type: "<xref href=\"com.azure.resourcemanager.machinelearning.models.TrainingSettings?alt=com.azure.resourcemanager.machinelearning.models.TrainingSettings&text=TrainingSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.stackEnsembleSettings()"
fullName: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.stackEnsembleSettings()"
name: "stackEnsembleSettings()"
nameWithType: "TrainingSettings.stackEnsembleSettings()"
summary: "Get the stack<wbr>Ensemble<wbr>Settings property: Stack ensemble settings for stack ensemble run."
syntax: "public StackEnsembleSettings stackEnsembleSettings()"
desc: "Get the stackEnsembleSettings property: Stack ensemble settings for stack ensemble run."
returns:
description: "the stackEnsembleSettings value."
type: "<xref href=\"com.azure.resourcemanager.machinelearning.models.StackEnsembleSettings?alt=com.azure.resourcemanager.machinelearning.models.StackEnsembleSettings&text=StackEnsembleSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "TrainingSettings.toJson(JsonWriter jsonWriter)"
parameters:
- name: "jsonWriter"
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns:
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.validate()"
fullName: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.validate()"
name: "validate()"
nameWithType: "TrainingSettings.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.withEnableDnnTraining(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.withEnableDnnTraining(Boolean enableDnnTraining)"
name: "withEnableDnnTraining(Boolean enableDnnTraining)"
nameWithType: "TrainingSettings.withEnableDnnTraining(Boolean enableDnnTraining)"
summary: "Set the enable<wbr>Dnn<wbr>Training property: Enable recommendation of DNN models."
parameters:
- description: "the enableDnnTraining value to set."
name: "enableDnnTraining"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public TrainingSettings withEnableDnnTraining(Boolean enableDnnTraining)"
desc: "Set the enableDnnTraining property: Enable recommendation of DNN models."
returns:
description: "the TrainingSettings object itself."
type: "<xref href=\"com.azure.resourcemanager.machinelearning.models.TrainingSettings?alt=com.azure.resourcemanager.machinelearning.models.TrainingSettings&text=TrainingSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.withEnableModelExplainability(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.withEnableModelExplainability(Boolean enableModelExplainability)"
name: "withEnableModelExplainability(Boolean enableModelExplainability)"
nameWithType: "TrainingSettings.withEnableModelExplainability(Boolean enableModelExplainability)"
summary: "Set the enable<wbr>Model<wbr>Explainability property: Flag to turn on explainability on best model."
parameters:
- description: "the enableModelExplainability value to set."
name: "enableModelExplainability"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public TrainingSettings withEnableModelExplainability(Boolean enableModelExplainability)"
desc: "Set the enableModelExplainability property: Flag to turn on explainability on best model."
returns:
description: "the TrainingSettings object itself."
type: "<xref href=\"com.azure.resourcemanager.machinelearning.models.TrainingSettings?alt=com.azure.resourcemanager.machinelearning.models.TrainingSettings&text=TrainingSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.withEnableOnnxCompatibleModels(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.withEnableOnnxCompatibleModels(Boolean enableOnnxCompatibleModels)"
name: "withEnableOnnxCompatibleModels(Boolean enableOnnxCompatibleModels)"
nameWithType: "TrainingSettings.withEnableOnnxCompatibleModels(Boolean enableOnnxCompatibleModels)"
summary: "Set the enable<wbr>Onnx<wbr>Compatible<wbr>Models property: Flag for enabling onnx compatible models."
parameters:
- description: "the enableOnnxCompatibleModels value to set."
name: "enableOnnxCompatibleModels"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public TrainingSettings withEnableOnnxCompatibleModels(Boolean enableOnnxCompatibleModels)"
desc: "Set the enableOnnxCompatibleModels property: Flag for enabling onnx compatible models."
returns:
description: "the TrainingSettings object itself."
type: "<xref href=\"com.azure.resourcemanager.machinelearning.models.TrainingSettings?alt=com.azure.resourcemanager.machinelearning.models.TrainingSettings&text=TrainingSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.withEnableStackEnsemble(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.withEnableStackEnsemble(Boolean enableStackEnsemble)"
name: "withEnableStackEnsemble(Boolean enableStackEnsemble)"
nameWithType: "TrainingSettings.withEnableStackEnsemble(Boolean enableStackEnsemble)"
summary: "Set the enable<wbr>Stack<wbr>Ensemble property: Enable stack ensemble run."
parameters:
- description: "the enableStackEnsemble value to set."
name: "enableStackEnsemble"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public TrainingSettings withEnableStackEnsemble(Boolean enableStackEnsemble)"
desc: "Set the enableStackEnsemble property: Enable stack ensemble run."
returns:
description: "the TrainingSettings object itself."
type: "<xref href=\"com.azure.resourcemanager.machinelearning.models.TrainingSettings?alt=com.azure.resourcemanager.machinelearning.models.TrainingSettings&text=TrainingSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.withEnableVoteEnsemble(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.withEnableVoteEnsemble(Boolean enableVoteEnsemble)"
name: "withEnableVoteEnsemble(Boolean enableVoteEnsemble)"
nameWithType: "TrainingSettings.withEnableVoteEnsemble(Boolean enableVoteEnsemble)"
summary: "Set the enable<wbr>Vote<wbr>Ensemble property: Enable voting ensemble run."
parameters:
- description: "the enableVoteEnsemble value to set."
name: "enableVoteEnsemble"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public TrainingSettings withEnableVoteEnsemble(Boolean enableVoteEnsemble)"
desc: "Set the enableVoteEnsemble property: Enable voting ensemble run."
returns:
description: "the TrainingSettings object itself."
type: "<xref href=\"com.azure.resourcemanager.machinelearning.models.TrainingSettings?alt=com.azure.resourcemanager.machinelearning.models.TrainingSettings&text=TrainingSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.withEnsembleModelDownloadTimeout(java.time.Duration)"
fullName: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.withEnsembleModelDownloadTimeout(Duration ensembleModelDownloadTimeout)"
name: "withEnsembleModelDownloadTimeout(Duration ensembleModelDownloadTimeout)"
nameWithType: "TrainingSettings.withEnsembleModelDownloadTimeout(Duration ensembleModelDownloadTimeout)"
summary: "Set the ensemble<wbr>Model<wbr>Download<wbr>Timeout property: During Voting<wbr>Ensemble and Stack<wbr>Ensemble model generation, multiple fitted models from the previous child runs are downloaded."
parameters:
- description: "the ensembleModelDownloadTimeout value to set."
name: "ensembleModelDownloadTimeout"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
syntax: "public TrainingSettings withEnsembleModelDownloadTimeout(Duration ensembleModelDownloadTimeout)"
desc: "Set the ensembleModelDownloadTimeout property: During VotingEnsemble and StackEnsemble model generation, multiple fitted models from the previous child runs are downloaded. Configure this parameter with a higher value than 300 secs, if more time is needed."
returns:
description: "the TrainingSettings object itself."
type: "<xref href=\"com.azure.resourcemanager.machinelearning.models.TrainingSettings?alt=com.azure.resourcemanager.machinelearning.models.TrainingSettings&text=TrainingSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.withStackEnsembleSettings(com.azure.resourcemanager.machinelearning.models.StackEnsembleSettings)"
fullName: "com.azure.resourcemanager.machinelearning.models.TrainingSettings.withStackEnsembleSettings(StackEnsembleSettings stackEnsembleSettings)"
name: "withStackEnsembleSettings(StackEnsembleSettings stackEnsembleSettings)"
nameWithType: "TrainingSettings.withStackEnsembleSettings(StackEnsembleSettings stackEnsembleSettings)"
summary: "Set the stack<wbr>Ensemble<wbr>Settings property: Stack ensemble settings for stack ensemble run."
parameters:
- description: "the stackEnsembleSettings value to set."
name: "stackEnsembleSettings"
type: "<xref href=\"com.azure.resourcemanager.machinelearning.models.StackEnsembleSettings?alt=com.azure.resourcemanager.machinelearning.models.StackEnsembleSettings&text=StackEnsembleSettings\" data-throw-if-not-resolved=\"False\" />"
syntax: "public TrainingSettings withStackEnsembleSettings(StackEnsembleSettings stackEnsembleSettings)"
desc: "Set the stackEnsembleSettings property: Stack ensemble settings for stack ensemble run."
returns:
description: "the TrainingSettings object itself."
type: "<xref href=\"com.azure.resourcemanager.machinelearning.models.TrainingSettings?alt=com.azure.resourcemanager.machinelearning.models.TrainingSettings&text=TrainingSettings\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Training related configuration."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.machinelearning.models.TrainingSettings?alt=com.azure.resourcemanager.machinelearning.models.TrainingSettings&text=TrainingSettings\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.machinelearning.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-machinelearning:1.1.0