Class ModelTrainingDataChannel

java.lang.Object
software.amazon.awssdk.services.cleanroomsml.model.ModelTrainingDataChannel
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ModelTrainingDataChannel.Builder,ModelTrainingDataChannel>
@Generated("software.amazon.awssdk:codegen") public final class ModelTrainingDataChannel extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ModelTrainingDataChannel.Builder,ModelTrainingDataChannel>

Information about the model training data channel. A training data channel is a named data source that the training algorithms can consume.

See Also:

  • Method Details

    • mlInputChannelArn

      public final String mlInputChannelArn()

      The Amazon Resource Name (ARN) of the ML input channel for this model training data channel.

      Returns:
      The Amazon Resource Name (ARN) of the ML input channel for this model training data channel.

    • channelName

      public final String channelName()

      The name of the training data channel.

      Returns:
      The name of the training data channel.

    • s3DataDistributionType

      public final S3DataDistributionType s3DataDistributionType()

      Specifies how the training data stored in Amazon S3 should be distributed to training instances. This parameter controls the data distribution strategy for the training job:

      • FullyReplicated - The entire dataset is replicated on each training instance. This is suitable for smaller datasets and algorithms that require access to the complete dataset.

      • ShardedByS3Key - The dataset is distributed across training instances based on Amazon S3 key names. This is suitable for larger datasets and distributed training scenarios where each instance processes a subset of the data.

      If the service returns an enum value that is not available in the current SDK version, s3DataDistributionType will return S3DataDistributionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3DataDistributionTypeAsString().

      Returns:
      Specifies how the training data stored in Amazon S3 should be distributed to training instances. This parameter controls the data distribution strategy for the training job:

      • FullyReplicated - The entire dataset is replicated on each training instance. This is suitable for smaller datasets and algorithms that require access to the complete dataset.

      • ShardedByS3Key - The dataset is distributed across training instances based on Amazon S3 key names. This is suitable for larger datasets and distributed training scenarios where each instance processes a subset of the data.

      See Also:

    • s3DataDistributionTypeAsString

      public final String s3DataDistributionTypeAsString()

      Specifies how the training data stored in Amazon S3 should be distributed to training instances. This parameter controls the data distribution strategy for the training job:

      • FullyReplicated - The entire dataset is replicated on each training instance. This is suitable for smaller datasets and algorithms that require access to the complete dataset.

      • ShardedByS3Key - The dataset is distributed across training instances based on Amazon S3 key names. This is suitable for larger datasets and distributed training scenarios where each instance processes a subset of the data.

      If the service returns an enum value that is not available in the current SDK version, s3DataDistributionType will return S3DataDistributionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3DataDistributionTypeAsString().

      Returns:
      Specifies how the training data stored in Amazon S3 should be distributed to training instances. This parameter controls the data distribution strategy for the training job:

      • FullyReplicated - The entire dataset is replicated on each training instance. This is suitable for smaller datasets and algorithms that require access to the complete dataset.

      • ShardedByS3Key - The dataset is distributed across training instances based on Amazon S3 key names. This is suitable for larger datasets and distributed training scenarios where each instance processes a subset of the data.

      See Also:

    • toBuilder

      public ModelTrainingDataChannel.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<ModelTrainingDataChannel.Builder,ModelTrainingDataChannel>
      Returns:
      a builder for type T

    • builder

      public static ModelTrainingDataChannel.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ModelTrainingDataChannel.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.