S3DataSource: Defines a data source given by a bucket and S3 prefix.

In DyfanJones/sagemaker-r-local: Sagemaker core classes, methods and functions

Defines a data source given by a bucket and S3 prefix.

Description

The contents will be downloaded and then processed as local data.

Super class

sagemaker.core::DataSource -> S3DataSource

Methods

Public methods

• S3DataSource$new()

• S3DataSource$get_file_list()

• S3DataSource$get_root_dir()

• S3DataSource$clone()

Inherited methods

---

Method new()

Create an S3DataSource instance.

Usage

S3DataSource$new(bucket, prefix, sagemaker_session)

Arguments

bucket

(str): S3 bucket name

prefix

(str): S3 prefix path to the data

sagemaker_session

(:class:'sagemaker.session.Session'): a sagemaker_session with the desired settings to talk to S3

---

Method get_file_list()

Retrieve the list of absolute paths to all the files in this data source.

Usage

S3DataSource$get_file_list()

Returns

List(str): List of absolute paths.

---

Method get_root_dir()

Retrieve the absolute path to the root directory of this data source.

Usage

S3DataSource$get_root_dir()

Returns

str: absolute path to the root directory of this data source.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

S3DataSource$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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