Class AutoMLCandidateGenerationConfig

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.AutoMLCandidateGenerationConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AutoMLCandidateGenerationConfig.Builder,AutoMLCandidateGenerationConfig>
@Generated("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:

  • Method Details

    • 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 trained on tabular data.

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

      • AlgorithmsConfig should not be set if the training mode is set on AUTO.

      • 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, CandidateGenerationConfig uses the full set of algorithms for the given training mode.

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

      For the list of all algorithms per problem type and 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 trained on tabular data.

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

      • AlgorithmsConfig should not be set if the training mode is set on AUTO.

      • 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, CandidateGenerationConfig uses the full set of algorithms for the given training mode.

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

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

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

    • toBuilder

      public AutoMLCandidateGenerationConfig.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AutoMLCandidateGenerationConfig.Builder,AutoMLCandidateGenerationConfig>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.