-
Notifications
You must be signed in to change notification settings - Fork 246
/
azure.ai.ml.automl.TrainingSettings.yml
103 lines (101 loc) · 4 KB
/
azure.ai.ml.automl.TrainingSettings.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
### YamlMime:PythonClass
uid: azure.ai.ml.automl.TrainingSettings
name: TrainingSettings
fullName: azure.ai.ml.automl.TrainingSettings
module: azure.ai.ml.automl
inheritances:
- azure.ai.ml.entities._mixins.RestTranslatableMixin
summary: 'TrainingSettings class for Azure Machine Learning.
TrainingSettings class for Azure Machine Learning.'
constructor:
syntax: 'TrainingSettings(*, enable_onnx_compatible_models: bool | None = None,
enable_dnn_training: bool | None = None, enable_model_explainability: bool | None
= None, enable_stack_ensemble: bool | None = None, enable_vote_ensemble: bool
| None = None, stack_ensemble_settings: StackEnsembleSettings | None = None, ensemble_model_download_timeout:
int | None = None, allowed_training_algorithms: List[str] | None = None, blocked_training_algorithms:
List[str] | None = None, training_mode: str | TrainingMode | None = None)'
parameters:
- name: enable_onnx_compatible_models
description: If set to True, the model will be trained to be compatible with ONNX
isRequired: true
types:
- <xref:typing.Optional>[<xref:bool>]
- name: enable_dnn_training
description: If set to True,the model will use DNN training
isRequired: true
types:
- <xref:typing.Optional>[<xref:bool>]
- name: enable_model_explainability
description: If set to True, the model will be trained to be explainable
isRequired: true
types:
- <xref:typing.Optional>[<xref:bool>]
- name: enable_stack_ensemble
description: If set to True, a final ensemble model will be created using a stack
of models
isRequired: true
types:
- <xref:typing.Optional>[<xref:bool>]
- name: enable_vote_ensemble
description: If set to True, a final ensemble model will be created using a voting
ensemble
isRequired: true
types:
- <xref:typing.Optional>[<xref:bool>]
- name: stack_ensemble_settings
description: Settings for stack ensemble
isRequired: true
types:
- <xref:typing.Optional>[<xref:azure.ai.ml.automl.StackEnsembleSettings>]
- name: ensemble_model_download_timeout
description: Timeout for downloading ensemble models
isRequired: true
types:
- <xref:typing.Optional>[<xref:typing.List>[<xref:int>]]
- name: allowed_training_algorithms
description: Models to train
isRequired: true
types:
- <xref:typing.Optional>[<xref:typing.List>[<xref:str>]]
- name: blocked_training_algorithms
description: Models that will not be considered for training
isRequired: true
types:
- <xref:typing.Optional>[<xref:typing.List>[<xref:str>]]
- name: training_mode
description: "[Experimental] The training mode to use.\nThe possible values are-\n\
\n* distributed- enables distributed training for supported algorithms. \n\n\
* non_distributed- disables distributed training. \n\n* auto- Currently, it\
\ is same as non_distributed. In future, this might change. \n\nNote: This parameter\
\ is in public preview and may change in future."
isRequired: true
types:
- <xref:typing.Optional>[<xref:typing.Union>[<xref:str>, <xref:azure.ai.ml.constants.TabularTrainingMode>]]
keywordOnlyParameters:
- name: enable_onnx_compatible_models
isRequired: true
- name: enable_dnn_training
isRequired: true
- name: enable_model_explainability
isRequired: true
- name: enable_stack_ensemble
isRequired: true
- name: enable_vote_ensemble
isRequired: true
- name: stack_ensemble_settings
isRequired: true
- name: ensemble_model_download_timeout
isRequired: true
- name: allowed_training_algorithms
isRequired: true
- name: blocked_training_algorithms
isRequired: true
- name: training_mode
isRequired: true
attributes:
- uid: azure.ai.ml.automl.TrainingSettings.allowed_training_algorithms
name: allowed_training_algorithms
- uid: azure.ai.ml.automl.TrainingSettings.blocked_training_algorithms
name: blocked_training_algorithms
- uid: azure.ai.ml.automl.TrainingSettings.training_mode
name: training_mode