You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SageMaker::Types::Channel

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Note:

When making an API call, you may pass Channel data as a hash:

{
  channel_name: "ChannelName", # required
  data_source: { # required
    s3_data_source: { # required
      s3_data_type: "ManifestFile", # required, accepts ManifestFile, S3Prefix
      s3_uri: "S3Uri", # required
      s3_data_distribution_type: "FullyReplicated", # accepts FullyReplicated, ShardedByS3Key
    },
  },
  content_type: "ContentType",
  compression_type: "None", # accepts None, Gzip
  record_wrapper_type: "None", # accepts None, RecordIO
}

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#channel_name ⇒ String

The name of the channel.

Returns:

  • (String) 


198
199
200
201
202
203
204
205
 
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 198

class Channel < Struct.new(
  :channel_name,
  :data_source,
  :content_type,
  :compression_type,
  :record_wrapper_type)
  include Aws::Structure
end

#compression_type ⇒ String

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.

Returns:

  • (String) 


198
199
200
201
202
203
204
205
 
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 198

class Channel < Struct.new(
  :channel_name,
  :data_source,
  :content_type,
  :compression_type,
  :record_wrapper_type)
  include Aws::Structure
end

#content_type ⇒ String

The MIME type of the data.

Returns:

  • (String) 


198
199
200
201
202
203
204
205
 
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 198

class Channel < Struct.new(
  :channel_name,
  :data_source,
  :content_type,
  :compression_type,
  :record_wrapper_type)
  include Aws::Structure
end

#data_source ⇒ Types::DataSource

The location of the channel data.

Returns:



198
199
200
201
202
203
204
205
 
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 198

class Channel < Struct.new(
  :channel_name,
  :data_source,
  :content_type,
  :compression_type,
  :record_wrapper_type)
  include Aws::Structure
end

#record_wrapper_type ⇒ String

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

Returns:

  • (String) 


198
199
200
201
202
203
204
205
 
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 198

class Channel < Struct.new(
  :channel_name,
  :data_source,
  :content_type,
  :compression_type,
  :record_wrapper_type)
  include Aws::Structure
end