AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inheritance Hierarchy

System.Object
  Amazon.SageMaker.Model.Channel

Namespace: Amazon.SageMaker.Model
Assembly: AWSSDK.SageMaker.dll
Version: 3.x.y.z

Syntax

C#
public class Channel

The Channel type exposes the following members

Constructors

NameDescription
Public Method Channel()

Properties

NameTypeDescription
Public Property ChannelName System.String

Gets and sets the property ChannelName.

The name of the channel.

Public Property CompressionType Amazon.SageMaker.CompressionType

Gets and sets the property 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.

Public Property ContentType System.String

Gets and sets the property ContentType.

The MIME type of the data.

Public Property DataSource Amazon.SageMaker.Model.DataSource

Gets and sets the property DataSource.

The location of the channel data.

Public Property InputMode Amazon.SageMaker.TrainingInputMode

Gets and sets the property 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 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.

Public Property RecordWrapperType Amazon.SageMaker.RecordWrapper

Gets and sets the property 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.

Public Property ShuffleConfig Amazon.SageMaker.Model.ShuffleConfig

Gets and sets the property ShuffleConfig.

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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5