Skip to content

DatasetDefinition

Source code in docs_src/capo_sagemaker/types/dataset_definition.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class DatasetDefinition(TypedDict, closed=True):
    athena_dataset_definition: NotRequired[
        "capo_sagemaker.types.athena_dataset_definition.AthenaDatasetDefinition"
    ]
    redshift_dataset_definition: NotRequired[
        "capo_sagemaker.types.redshift_dataset_definition.RedshiftDatasetDefinition"
    ]
    local_path: NotRequired[
        "capo_sagemaker.types.processing_local_path.ProcessingLocalPath"
    ]
    """<p>The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a processing job. <code>LocalPath</code> is an absolute path to the input data. This is a required parameter when <code>AppManaged</code> is <code>False</code> (default).</p>"""
    data_distribution_type: NotRequired[
        "capo_sagemaker.types.data_distribution_type.DataDistributionType"
    ]
    """<p>Whether the generated dataset is <code>FullyReplicated</code> or <code>ShardedByS3Key</code> (default).</p>"""
    input_mode: NotRequired["capo_sagemaker.types.input_mode.InputMode"]
    """<p>Whether to use <code>File</code> or <code>Pipe</code> input mode. In <code>File</code> (default) 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 <code>Pipe</code> mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.</p>"""

athena_dataset_definition instance-attribute 

athena_dataset_definition: NotRequired[AthenaDatasetDefinition]

data_distribution_type instance-attribute 

data_distribution_type: NotRequired[DataDistributionType]

Whether the generated dataset is FullyReplicated or ShardedByS3Key (default).

input_mode instance-attribute 

input_mode: NotRequired[InputMode]

Whether to use File or Pipe input mode. In File (default) 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.

local_path instance-attribute 

local_path: NotRequired[ProcessingLocalPath]

The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a processing job. LocalPath is an absolute path to the input data. This is a required parameter when AppManaged is False (default).

redshift_dataset_definition instance-attribute 

redshift_dataset_definition: NotRequired[RedshiftDatasetDefinition]