FileSystemRecordSet: FileSystemRecordSet Class

In DyfanJones/sagemaker-r-mlcore: sagemaker machine learning core classes and methods

FileSystemRecordSet Class

Description

Amazon SageMaker channel configuration for a file system data source for Amazon algorithms.

Public fields

feature_dim

The dimensionality of "values" arrays in the Record features

num_records

The number of records in the set

channel

The SageMaker Training Job channel this RecordSet should be bound to

Methods

Public methods

• FileSystemRecordSet$new()

• FileSystemRecordSet$print()

• FileSystemRecordSet$data_channel()

• FileSystemRecordSet$clone()

---

Method new()

Initialize a “FileSystemRecordSet“ object.

Usage

FileSystemRecordSet$new(
  file_system_id,
  file_system_type,
  directory_path,
  num_records,
  feature_dim,
  file_system_access_mode = "ro",
  channel = "train"
)

Arguments

file_system_id

(str): An Amazon file system ID starting with 'fs-'.

file_system_type

(str): The type of file system used for the input. Valid values: 'EFS', 'FSxLustre'.

directory_path

(str): Absolute or normalized path to the root directory (mount point) in the file system. Reference: https://docs.aws.amazon.com/efs/latest/ug/mounting-fs.html and https://docs.aws.amazon.com/efs/latest/ug/wt1-test.html

num_records

(int): The number of records in the set.

feature_dim

(int): The dimensionality of "values" arrays in the Record features, and label (if each Record is labeled).

file_system_access_mode

(str): Permissions for read and write. Valid values: 'ro' or 'rw'. Defaults to 'ro'.

channel

(str): The SageMaker Training Job channel this RecordSet should be bound to

---

Method print()

Return an unambiguous representation of this RecordSet

Return an unambiguous representation of this RecordSet

Usage

FileSystemRecordSet$print()

---

Method data_channel()

Return a dictionary to represent the training data in a channel for use with “fit()“

Usage

FileSystemRecordSet$data_channel()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

FileSystemRecordSet$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

DyfanJones/sagemaker-r-mlcore documentation built on May 3, 2022, 10:08 a.m.