Class: Aws::SageMaker::Types::AutoMLS3DataSource

Inherits:

Struct

Object
Struct
Aws::SageMaker::Types::AutoMLS3DataSource

show all

Defined in:: gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Describes the Amazon S3 data source.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#s3_data_type ⇒ String
The data type.
#s3_uri ⇒ String
The URL to the Amazon S3 data source.

Instance Attribute Details

#s3_data_type ⇒ `String`

The data type.

If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker AI uses all objects that match the specified key name prefix for model training.

The S3Prefix should have the following format:

s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILE
If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want SageMaker AI to use for model training.

A ManifestFile should have the format shown below:

[ {"prefix": "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/DOC-EXAMPLE-PREFIX/"},

"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-1",

"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-2",

... "DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-N" ]
If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile is available for V2 API jobs only (for example, for jobs created by calling CreateAutoMLJobV2).

Here is a minimal, single-record example of an AugmentedManifestFile:

{"source-ref": "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/cats/cat.jpg",

"label-metadata": {"class-name": "cat" }

For more information on AugmentedManifestFile, see Provide Dataset Metadata to Training Jobs with an Augmented Manifest File.

Returns:

(String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3015

class AutoMLS3DataSource < Struct.new(
  :s3_data_type,
  :s3_uri)
  SENSITIVE = []
  include Aws::Structure
end

#s3_uri ⇒ `String`

The URL to the Amazon S3 data source. The Uri refers to the Amazon S3 prefix or ManifestFile depending on the data type.