AWS SDK for C++  1.9.126
AWS SDK for C++
Public Member Functions | List of all members
Aws::SageMaker::Model::Channel Class Reference

#include <Channel.h>

Public Member Functions

 Channel ()
 
 Channel (Aws::Utils::Json::JsonView jsonValue)
 
Channeloperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetChannelName () const
 
bool ChannelNameHasBeenSet () const
 
void SetChannelName (const Aws::String &value)
 
void SetChannelName (Aws::String &&value)
 
void SetChannelName (const char *value)
 
ChannelWithChannelName (const Aws::String &value)
 
ChannelWithChannelName (Aws::String &&value)
 
ChannelWithChannelName (const char *value)
 
const DataSourceGetDataSource () const
 
bool DataSourceHasBeenSet () const
 
void SetDataSource (const DataSource &value)
 
void SetDataSource (DataSource &&value)
 
ChannelWithDataSource (const DataSource &value)
 
ChannelWithDataSource (DataSource &&value)
 
const Aws::StringGetContentType () const
 
bool ContentTypeHasBeenSet () const
 
void SetContentType (const Aws::String &value)
 
void SetContentType (Aws::String &&value)
 
void SetContentType (const char *value)
 
ChannelWithContentType (const Aws::String &value)
 
ChannelWithContentType (Aws::String &&value)
 
ChannelWithContentType (const char *value)
 
const CompressionTypeGetCompressionType () const
 
bool CompressionTypeHasBeenSet () const
 
void SetCompressionType (const CompressionType &value)
 
void SetCompressionType (CompressionType &&value)
 
ChannelWithCompressionType (const CompressionType &value)
 
ChannelWithCompressionType (CompressionType &&value)
 
const RecordWrapperGetRecordWrapperType () const
 
bool RecordWrapperTypeHasBeenSet () const
 
void SetRecordWrapperType (const RecordWrapper &value)
 
void SetRecordWrapperType (RecordWrapper &&value)
 
ChannelWithRecordWrapperType (const RecordWrapper &value)
 
ChannelWithRecordWrapperType (RecordWrapper &&value)
 
const TrainingInputModeGetInputMode () const
 
bool InputModeHasBeenSet () const
 
void SetInputMode (const TrainingInputMode &value)
 
void SetInputMode (TrainingInputMode &&value)
 
ChannelWithInputMode (const TrainingInputMode &value)
 
ChannelWithInputMode (TrainingInputMode &&value)
 
const ShuffleConfigGetShuffleConfig () const
 
bool ShuffleConfigHasBeenSet () const
 
void SetShuffleConfig (const ShuffleConfig &value)
 
void SetShuffleConfig (ShuffleConfig &&value)
 
ChannelWithShuffleConfig (const ShuffleConfig &value)
 
ChannelWithShuffleConfig (ShuffleConfig &&value)
 

Detailed Description

A channel is a named input source that training algorithms can consume.

See Also:

AWS API Reference

Definition at line 37 of file Channel.h.

Constructor & Destructor Documentation

◆ Channel() [1/2]

Aws::SageMaker::Model::Channel::Channel ( )

◆ Channel() [2/2]

Aws::SageMaker::Model::Channel::Channel ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ChannelNameHasBeenSet()

bool Aws::SageMaker::Model::Channel::ChannelNameHasBeenSet ( ) const
inline

The name of the channel.

Definition at line 54 of file Channel.h.

◆ CompressionTypeHasBeenSet()

bool Aws::SageMaker::Model::Channel::CompressionTypeHasBeenSet ( ) const
inline

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.

Definition at line 171 of file Channel.h.

◆ ContentTypeHasBeenSet()

bool Aws::SageMaker::Model::Channel::ContentTypeHasBeenSet ( ) const
inline

The MIME type of the data.

Definition at line 126 of file Channel.h.

◆ DataSourceHasBeenSet()

bool Aws::SageMaker::Model::Channel::DataSourceHasBeenSet ( ) const
inline

The location of the channel data.

Definition at line 95 of file Channel.h.

◆ GetChannelName()

const Aws::String& Aws::SageMaker::Model::Channel::GetChannelName ( ) const
inline

The name of the channel.

Definition at line 49 of file Channel.h.

◆ GetCompressionType()

const CompressionType& Aws::SageMaker::Model::Channel::GetCompressionType ( ) const
inline

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.

Definition at line 164 of file Channel.h.

◆ GetContentType()

const Aws::String& Aws::SageMaker::Model::Channel::GetContentType ( ) const
inline

The MIME type of the data.

Definition at line 121 of file Channel.h.

◆ GetDataSource()

const DataSource& Aws::SageMaker::Model::Channel::GetDataSource ( ) const
inline

The location of the channel data.

Definition at line 90 of file Channel.h.

◆ GetInputMode()

const TrainingInputMode& Aws::SageMaker::Model::Channel::GetInputMode ( ) const
inline

(Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, Amazon SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode 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, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.

To use a model for incremental training, choose File input model.

Definition at line 288 of file Channel.h.

◆ GetRecordWrapperType()

const RecordWrapper& Aws::SageMaker::Model::Channel::GetRecordWrapperType ( ) const
inline

Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon 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.

Definition at line 212 of file Channel.h.

◆ GetShuffleConfig()

const ShuffleConfig& Aws::SageMaker::Model::Channel::GetShuffleConfig ( ) const
inline

A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed 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 of ShardedByS3Key, 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.

Definition at line 382 of file Channel.h.

◆ InputModeHasBeenSet()

bool Aws::SageMaker::Model::Channel::InputModeHasBeenSet ( ) const
inline

(Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, Amazon SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode 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, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.

To use a model for incremental training, choose File input model.

Definition at line 303 of file Channel.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::SageMaker::Model::Channel::Jsonize ( ) const

◆ operator=()

Channel& Aws::SageMaker::Model::Channel::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RecordWrapperTypeHasBeenSet()

bool Aws::SageMaker::Model::Channel::RecordWrapperTypeHasBeenSet ( ) const
inline

Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon 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.

Definition at line 224 of file Channel.h.

◆ SetChannelName() [1/3]

void Aws::SageMaker::Model::Channel::SetChannelName ( Aws::String &&  value)
inline

The name of the channel.

Definition at line 64 of file Channel.h.

◆ SetChannelName() [2/3]

void Aws::SageMaker::Model::Channel::SetChannelName ( const Aws::String value)
inline

The name of the channel.

Definition at line 59 of file Channel.h.

◆ SetChannelName() [3/3]

void Aws::SageMaker::Model::Channel::SetChannelName ( const char *  value)
inline

The name of the channel.

Definition at line 69 of file Channel.h.

◆ SetCompressionType() [1/2]

void Aws::SageMaker::Model::Channel::SetCompressionType ( CompressionType &&  value)
inline

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.

Definition at line 185 of file Channel.h.

◆ SetCompressionType() [2/2]

void Aws::SageMaker::Model::Channel::SetCompressionType ( const CompressionType value)
inline

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.

Definition at line 178 of file Channel.h.

◆ SetContentType() [1/3]

void Aws::SageMaker::Model::Channel::SetContentType ( Aws::String &&  value)
inline

The MIME type of the data.

Definition at line 136 of file Channel.h.

◆ SetContentType() [2/3]

void Aws::SageMaker::Model::Channel::SetContentType ( const Aws::String value)
inline

The MIME type of the data.

Definition at line 131 of file Channel.h.

◆ SetContentType() [3/3]

void Aws::SageMaker::Model::Channel::SetContentType ( const char *  value)
inline

The MIME type of the data.

Definition at line 141 of file Channel.h.

◆ SetDataSource() [1/2]

void Aws::SageMaker::Model::Channel::SetDataSource ( const DataSource value)
inline

The location of the channel data.

Definition at line 100 of file Channel.h.

◆ SetDataSource() [2/2]

void Aws::SageMaker::Model::Channel::SetDataSource ( DataSource &&  value)
inline

The location of the channel data.

Definition at line 105 of file Channel.h.

◆ SetInputMode() [1/2]

void Aws::SageMaker::Model::Channel::SetInputMode ( const TrainingInputMode value)
inline

(Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, Amazon SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode 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, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.

To use a model for incremental training, choose File input model.

Definition at line 318 of file Channel.h.

◆ SetInputMode() [2/2]

void Aws::SageMaker::Model::Channel::SetInputMode ( TrainingInputMode &&  value)
inline

(Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, Amazon SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode 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, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.

To use a model for incremental training, choose File input model.

Definition at line 333 of file Channel.h.

◆ SetRecordWrapperType() [1/2]

void Aws::SageMaker::Model::Channel::SetRecordWrapperType ( const RecordWrapper value)
inline

Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon 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.

Definition at line 236 of file Channel.h.

◆ SetRecordWrapperType() [2/2]

void Aws::SageMaker::Model::Channel::SetRecordWrapperType ( RecordWrapper &&  value)
inline

Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon 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.

Definition at line 248 of file Channel.h.

◆ SetShuffleConfig() [1/2]

void Aws::SageMaker::Model::Channel::SetShuffleConfig ( const ShuffleConfig value)
inline

A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed 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 of ShardedByS3Key, 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.

Definition at line 418 of file Channel.h.

◆ SetShuffleConfig() [2/2]

void Aws::SageMaker::Model::Channel::SetShuffleConfig ( ShuffleConfig &&  value)
inline

A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed 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 of ShardedByS3Key, 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.

Definition at line 436 of file Channel.h.

◆ ShuffleConfigHasBeenSet()

bool Aws::SageMaker::Model::Channel::ShuffleConfigHasBeenSet ( ) const
inline

A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed 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 of ShardedByS3Key, 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.

Definition at line 400 of file Channel.h.

◆ WithChannelName() [1/3]

Channel& Aws::SageMaker::Model::Channel::WithChannelName ( Aws::String &&  value)
inline

The name of the channel.

Definition at line 79 of file Channel.h.

◆ WithChannelName() [2/3]

Channel& Aws::SageMaker::Model::Channel::WithChannelName ( const Aws::String value)
inline

The name of the channel.

Definition at line 74 of file Channel.h.

◆ WithChannelName() [3/3]

Channel& Aws::SageMaker::Model::Channel::WithChannelName ( const char *  value)
inline

The name of the channel.

Definition at line 84 of file Channel.h.

◆ WithCompressionType() [1/2]

Channel& Aws::SageMaker::Model::Channel::WithCompressionType ( CompressionType &&  value)
inline

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.

Definition at line 199 of file Channel.h.

◆ WithCompressionType() [2/2]

Channel& Aws::SageMaker::Model::Channel::WithCompressionType ( const CompressionType value)
inline

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.

Definition at line 192 of file Channel.h.

◆ WithContentType() [1/3]

Channel& Aws::SageMaker::Model::Channel::WithContentType ( Aws::String &&  value)
inline

The MIME type of the data.

Definition at line 151 of file Channel.h.

◆ WithContentType() [2/3]

Channel& Aws::SageMaker::Model::Channel::WithContentType ( const Aws::String value)
inline

The MIME type of the data.

Definition at line 146 of file Channel.h.

◆ WithContentType() [3/3]

Channel& Aws::SageMaker::Model::Channel::WithContentType ( const char *  value)
inline

The MIME type of the data.

Definition at line 156 of file Channel.h.

◆ WithDataSource() [1/2]

Channel& Aws::SageMaker::Model::Channel::WithDataSource ( const DataSource value)
inline

The location of the channel data.

Definition at line 110 of file Channel.h.

◆ WithDataSource() [2/2]

Channel& Aws::SageMaker::Model::Channel::WithDataSource ( DataSource &&  value)
inline

The location of the channel data.

Definition at line 115 of file Channel.h.

◆ WithInputMode() [1/2]

Channel& Aws::SageMaker::Model::Channel::WithInputMode ( const TrainingInputMode value)
inline

(Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, Amazon SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode 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, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.

To use a model for incremental training, choose File input model.

Definition at line 348 of file Channel.h.

◆ WithInputMode() [2/2]

Channel& Aws::SageMaker::Model::Channel::WithInputMode ( TrainingInputMode &&  value)
inline

(Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, Amazon SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode 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, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.

To use a model for incremental training, choose File input model.

Definition at line 363 of file Channel.h.

◆ WithRecordWrapperType() [1/2]

Channel& Aws::SageMaker::Model::Channel::WithRecordWrapperType ( const RecordWrapper value)
inline

Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon 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.

Definition at line 260 of file Channel.h.

◆ WithRecordWrapperType() [2/2]

Channel& Aws::SageMaker::Model::Channel::WithRecordWrapperType ( RecordWrapper &&  value)
inline

Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon 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.

Definition at line 272 of file Channel.h.

◆ WithShuffleConfig() [1/2]

Channel& Aws::SageMaker::Model::Channel::WithShuffleConfig ( const ShuffleConfig value)
inline

A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed 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 of ShardedByS3Key, 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.

Definition at line 454 of file Channel.h.

◆ WithShuffleConfig() [2/2]

Channel& Aws::SageMaker::Model::Channel::WithShuffleConfig ( ShuffleConfig &&  value)
inline

A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed 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 of ShardedByS3Key, 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.

Definition at line 472 of file Channel.h.


The documentation for this class was generated from the following file: