DatasetDefinition: DatasetDefinition input.

In DyfanJones/sagemaker-r-common: R6sagemaker lower level api calls

DatasetDefinition input.

Description

DatasetDefinition input.

DatasetDefinition input.

Super class

sagemaker.core::ApiObject -> DatasetDefinition

Methods

Public methods

• DatasetDefinition$new()

• DatasetDefinition$clone()

Inherited methods

• sagemaker.core::ApiObject$format()
• sagemaker.core::ApiObject$from_paws()
• sagemaker.core::ApiObject$to_paws()

---

Method new()

Initialize DatasetDefinition.

Usage

DatasetDefinition$new(
  data_distribution_type = "ShardedByS3Key",
  input_mode = "File",
  local_path = NULL,
  redshift_dataset_definition = NULL,
  athena_dataset_definition = NULL
)

Arguments

data_distribution_type

(str, default="ShardedByS3Key"): Whether the generated dataset is FullyReplicated or ShardedByS3Key (default).

input_mode

(str, default="File"): 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

(str, default=None): 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

(:class:sagemaker.common::RedshiftDatasetDefinition, default=None): Configuration for Redshift Dataset Definition input.

athena_dataset_definition

(:class:sagemaker.common::AthenaDatasetDefinition, default=None): Configuration for Athena Dataset Definition input.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

DatasetDefinition$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

DyfanJones/sagemaker-r-common documentation built on June 14, 2022, 10:31 p.m.