software.amazon.awssdk.services.sagemaker.model

Class AutoMLCandidateGenerationConfig

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.AutoMLCandidateGenerationConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AutoMLCandidateGenerationConfig.Builder,AutoMLCandidateGenerationConfig>

@Generated(value="software.amazon.awssdk:codegen")
public final class AutoMLCandidateGenerationConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AutoMLCandidateGenerationConfig.Builder,AutoMLCandidateGenerationConfig>

Stores the configuration information for how a candidate is generated (optional).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AutoMLCandidateGenerationConfig.Builder

Method Summary

Modifier and Type	Method and Description
List<AutoMLAlgorithmConfig>	algorithmsConfig() Stores the configuration information for the selection of algorithms used to train the model candidates.
static AutoMLCandidateGenerationConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	featureSpecificationS3Uri() A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAlgorithmsConfig() For responses, this returns true if the service returned a value for the AlgorithmsConfig property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends AutoMLCandidateGenerationConfig.Builder>	serializableBuilderClass()
AutoMLCandidateGenerationConfig.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

featureSpecificationS3Uri

public final String featureSpecificationS3Uri()

A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job. You can input FeatureAttributeNames (optional) in JSON format as shown below:

{ "FeatureAttributeNames":["col1", "col2", ...] }.

You can also specify the data type of the feature (optional) in the format shown below:

{ "FeatureDataTypes":{"col1":"numeric", "col2":"categorical" ... } }

These column keys may not include the target column.

In ensembling mode, Autopilot only supports the following data types: numeric, categorical, text, and datetime. In HPO mode, Autopilot can support numeric, categorical, text, datetime, and sequence.

If only FeatureDataTypes is provided, the column keys (col1, col2,..) should be a subset of the column names in the input data.

If both FeatureDataTypes and FeatureAttributeNames are provided, then the column keys should be a subset of the column names provided in FeatureAttributeNames.

The key name FeatureAttributeNames is fixed. The values listed in ["col1", "col2", ...] are case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.

Returns:

A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job. You can input FeatureAttributeNames (optional) in JSON format as shown below:

{ "FeatureAttributeNames":["col1", "col2", ...] }.

You can also specify the data type of the feature (optional) in the format shown below:

{ "FeatureDataTypes":{"col1":"numeric", "col2":"categorical" ... } }

These column keys may not include the target column.

In ensembling mode, Autopilot only supports the following data types: numeric, categorical, text, and datetime. In HPO mode, Autopilot can support numeric, categorical, text, datetime, and sequence.

If only FeatureDataTypes is provided, the column keys (col1, col2 ,..) should be a subset of the column names in the input data.

If both FeatureDataTypes and FeatureAttributeNames are provided, then the column keys should be a subset of the column names provided in FeatureAttributeNames.

The key name FeatureAttributeNames is fixed. The values listed in ["col1", "col2", ...] are case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.

hasAlgorithmsConfig

public final boolean hasAlgorithmsConfig()

For responses, this returns true if the service returned a value for the AlgorithmsConfig property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

algorithmsConfig

public final List<AutoMLAlgorithmConfig> algorithmsConfig()

Stores the configuration information for the selection of algorithms used to train the model candidates.

The list of available algorithms to choose from depends on the training mode set in AutoMLJobConfig.Mode .

• AlgorithmsConfig should not be set in AUTO training mode.

• When AlgorithmsConfig is provided, one AutoMLAlgorithms attribute must be set and one only.

  If the list of algorithms provided as values for AutoMLAlgorithms is empty, AutoMLCandidateGenerationConfig uses the full set of algorithms for the given training mode.

• When AlgorithmsConfig is not provided, AutoMLCandidateGenerationConfig uses the full set of algorithms for the given training mode.

For the list of all algorithms per training mode, see AutoMLAlgorithmConfig.

For more information on each algorithm, see the Algorithm support section in Autopilot developer guide.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAlgorithmsConfig() method.

Returns:

Stores the configuration information for the selection of algorithms used to train the model candidates.

The list of available algorithms to choose from depends on the training mode set in AutoMLJobConfig.Mode .

• AlgorithmsConfig should not be set in AUTO training mode.

• When AlgorithmsConfig is provided, one AutoMLAlgorithms attribute must be set and one only.

  If the list of algorithms provided as values for AutoMLAlgorithms is empty, AutoMLCandidateGenerationConfig uses the full set of algorithms for the given training mode.

• When AlgorithmsConfig is not provided, AutoMLCandidateGenerationConfig uses the full set of algorithms for the given training mode.

For the list of all algorithms per training mode, see AutoMLAlgorithmConfig.

For more information on each algorithm, see the Algorithm support section in Autopilot developer guide.

toBuilder

public AutoMLCandidateGenerationConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AutoMLCandidateGenerationConfig.Builder,AutoMLCandidateGenerationConfig>

builder

public static AutoMLCandidateGenerationConfig.Builder builder()

serializableBuilderClass

public static Class<? extends AutoMLCandidateGenerationConfig.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo