Skip to content

ChannelSpecification

Source code in docs_src/capo_sagemaker/types/channel_specification.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class ChannelSpecification(TypedDict, closed=True):
    name: NotRequired["capo_sagemaker.types.channel_name.ChannelName"]
    """<p>The name of the channel.</p>"""
    description: NotRequired[
        "capo_sagemaker.types.entity_description.EntityDescription"
    ]
    """<p>A brief description of the channel.</p>"""
    is_required: NotRequired["capo_sagemaker.types.boolean.Boolean"]
    """<p>Indicates whether the channel is required by the algorithm.</p>"""
    supported_content_types: NotRequired[
        "capo_sagemaker.types.content_types.ContentTypes"
    ]
    """<p>The supported MIME types for the data.</p>"""
    supported_compression_types: NotRequired[
        "capo_sagemaker.types.compression_types.CompressionTypes"
    ]
    """<p>The allowed compression types, if data compression is used.</p>"""
    supported_input_modes: NotRequired["capo_sagemaker.types.input_modes.InputModes"]
    """<p>The allowed input mode, either FILE or PIPE.</p> <p>In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode.</p> <p>In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.</p>"""

description instance-attribute 

description: NotRequired[EntityDescription]

A brief description of the channel.

is_required instance-attribute 

is_required: NotRequired[Boolean]

Indicates whether the channel is required by the algorithm.

name instance-attribute 

name: NotRequired[ChannelName]

The name of the channel.

supported_compression_types instance-attribute 

supported_compression_types: NotRequired[CompressionTypes]

The allowed compression types, if data compression is used.

supported_content_types instance-attribute 

supported_content_types: NotRequired[ContentTypes]

The supported MIME types for the data.

supported_input_modes instance-attribute 

supported_input_modes: NotRequired[InputModes]

The allowed input mode, either FILE or PIPE.

In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode.

In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.