Class Channel
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Channel.Builder,
Channel>
A channel is a named input source that training algorithms can consume.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Channel.Builder
builder()
final String
The name of the channel.final CompressionType
If training data is compressed, the compression type.final String
If training data is compressed, the compression type.final String
The MIME type of the data.final DataSource
The location of the channel data.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final TrainingInputMode
(Optional) The input mode to use for the data channel in a training job.final String
(Optional) The input mode to use for the data channel in a training job.final RecordWrapper
final String
static Class
<? extends Channel.Builder> final ShuffleConfig
A configuration for a shuffle option for input data in a channel.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
channelName
The name of the channel.
- Returns:
- The name of the channel.
-
dataSource
The location of the channel data.
- Returns:
- The location of the channel data.
-
contentType
The MIME type of the data.
- Returns:
- The MIME type of the data.
-
compressionType
If training data is compressed, the compression type. The default value is
None
.CompressionType
is used only in Pipe input mode. In File mode, leave this field unset or set it to None.If the service returns an enum value that is not available in the current SDK version,
compressionType
will returnCompressionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcompressionTypeAsString()
.- Returns:
- If training data is compressed, the compression type. The default value is
None
.CompressionType
is used only in Pipe input mode. In File mode, leave this field unset or set it to None. - See Also:
-
compressionTypeAsString
If training data is compressed, the compression type. The default value is
None
.CompressionType
is used only in Pipe input mode. In File mode, leave this field unset or set it to None.If the service returns an enum value that is not available in the current SDK version,
compressionType
will returnCompressionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcompressionTypeAsString()
.- Returns:
- If training data is compressed, the compression type. The default value is
None
.CompressionType
is used only in Pipe input mode. In File mode, leave this field unset or set it to None. - See Also:
-
recordWrapperType
Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.
In File mode, leave this field unset or set it to None.
If the service returns an enum value that is not available in the current SDK version,
recordWrapperType
will returnRecordWrapper.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrecordWrapperTypeAsString()
.- Returns:
Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.
In File mode, leave this field unset or set it to None.
- See Also:
-
recordWrapperTypeAsString
Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.
In File mode, leave this field unset or set it to None.
If the service returns an enum value that is not available in the current SDK version,
recordWrapperType
will returnRecordWrapper.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrecordWrapperTypeAsString()
.- Returns:
Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.
In File mode, leave this field unset or set it to None.
- See Also:
-
inputMode
(Optional) The input mode to use for the data channel in a training job. If you don't set a value for
InputMode
, SageMaker uses the value set forTrainingInputMode
. Use this parameter to override theTrainingInputMode
setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, useFile
input mode. To stream data directly from Amazon S3 to the container, choosePipe
input mode.To use a model for incremental training, choose
File
input model.If the service returns an enum value that is not available in the current SDK version,
inputMode
will returnTrainingInputMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominputModeAsString()
.- Returns:
- (Optional) The input mode to use for the data channel in a training job. If you don't set a value for
InputMode
, SageMaker uses the value set forTrainingInputMode
. Use this parameter to override theTrainingInputMode
setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, useFile
input mode. To stream data directly from Amazon S3 to the container, choosePipe
input mode.To use a model for incremental training, choose
File
input model. - See Also:
-
inputModeAsString
(Optional) The input mode to use for the data channel in a training job. If you don't set a value for
InputMode
, SageMaker uses the value set forTrainingInputMode
. Use this parameter to override theTrainingInputMode
setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, useFile
input mode. To stream data directly from Amazon S3 to the container, choosePipe
input mode.To use a model for incremental training, choose
File
input model.If the service returns an enum value that is not available in the current SDK version,
inputMode
will returnTrainingInputMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominputModeAsString()
.- Returns:
- (Optional) The input mode to use for the data channel in a training job. If you don't set a value for
InputMode
, SageMaker uses the value set forTrainingInputMode
. Use this parameter to override theTrainingInputMode
setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, useFile
input mode. To stream data directly from Amazon S3 to the container, choosePipe
input mode.To use a model for incremental training, choose
File
input model. - See Also:
-
shuffleConfig
A configuration for a shuffle option for input data in a channel. If you use
S3Prefix
forS3DataType
, this shuffles the results of the S3 key prefix matches. If you useManifestFile
, the order of the S3 object references in theManifestFile
is shuffled. If you useAugmentedManifestFile
, the order of the JSON lines in theAugmentedManifestFile
is shuffled. The shuffling order is determined using theSeed
value.For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with
S3DataDistributionType
ofShardedByS3Key
, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.- Returns:
- A configuration for a shuffle option for input data in a channel. If you use
S3Prefix
forS3DataType
, this shuffles the results of the S3 key prefix matches. If you useManifestFile
, the order of the S3 object references in theManifestFile
is shuffled. If you useAugmentedManifestFile
, the order of the JSON lines in theAugmentedManifestFile
is shuffled. The shuffling order is determined using theSeed
value.For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with
S3DataDistributionType
ofShardedByS3Key
, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.
-
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 interfaceToCopyableBuilder<Channel.Builder,
Channel> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-