Class Channel

Describes the training, validation or test dataset and the Amazon S3 location where it is stored.

Inheritance

System.Object

Channel

Implements

IChannel

Namespace: Amazon.CDK.AWS.StepFunctions.Tasks

Assembly: Amazon.CDK.AWS.StepFunctions.Tasks.dll

Syntax (csharp)

public class Channel : Object, IChannel

Syntax (vb)

Public Class Channel
    Inherits Object
    Implements IChannel

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.StepFunctions.Tasks;

S3Location s3Location;

var channel = new Channel {
    ChannelName = "channelName",
    DataSource = new DataSource {
        S3DataSource = new S3DataSource {
            S3Location = s3Location,

            // the properties below are optional
            AttributeNames = new [] { "attributeNames" },
            S3DataDistributionType = S3DataDistributionType.FULLY_REPLICATED,
            S3DataType = S3DataType.MANIFEST_FILE
        }
    },

    // the properties below are optional
    CompressionType = CompressionType.NONE,
    ContentType = "contentType",
    InputMode = InputMode.PIPE,
    RecordWrapperType = RecordWrapperType.NONE,
    ShuffleConfig = new ShuffleConfig {
        Seed = 123
    }
};

Synopsis

Constructors

Channel()

Properties

ChannelName	Name of the channel.
CompressionType	Compression type if training data is compressed.
ContentType	The MIME type of the data.
DataSource	Location of the channel data.
InputMode	Input mode to use for the data channel in a training job.
RecordWrapperType	Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format.
ShuffleConfig	Shuffle config option for input data in a channel.

Constructors

Channel()

public Channel()

Properties

ChannelName

Name of the channel.

public string ChannelName { get; set; }

Property Value

System.String

CompressionType

Compression type if training data is compressed.

public Nullable<CompressionType> CompressionType { get; set; }

Property Value

System.Nullable<CompressionType>

Remarks

Default: - None

ContentType

The MIME type of the data.

public string ContentType { get; set; }

Property Value

System.String

Remarks

Default: - None

DataSource

Location of the channel data.

public IDataSource DataSource { get; set; }

Property Value

IDataSource

InputMode

Input mode to use for the data channel in a training job.

public Nullable<InputMode> InputMode { get; set; }

Property Value

System.Nullable<InputMode>

Remarks

Default: - None

RecordWrapperType

Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format.

public Nullable<RecordWrapperType> RecordWrapperType { get; set; }

Property Value

System.Nullable<RecordWrapperType>

Remarks

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.

Default: - None

ShuffleConfig

Shuffle config option for input data in a channel.

public IShuffleConfig ShuffleConfig { get; set; }

Property Value

IShuffleConfig

Remarks

Default: - None

Implements

IChannel