Interface S3DataSpec.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<S3DataSpec.Builder,
,S3DataSpec> SdkBuilder<S3DataSpec.Builder,
,S3DataSpec> SdkPojo
- Enclosing class:
S3DataSpec
-
Method Summary
Modifier and TypeMethodDescriptiondataLocationS3
(String dataLocationS3) The location of the data file(s) used by aDataSource
.dataRearrangement
(String dataRearrangement) A JSON string that represents the splitting and rearrangement processing to be applied to aDataSource
.dataSchema
(String dataSchema) A JSON string that represents the schema for an Amazon S3DataSource
.dataSchemaLocationS3
(String dataSchemaLocationS3) Describes the schema location in Amazon S3.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
dataLocationS3
The location of the data file(s) used by a
DataSource
. The URI specifies a data file or an Amazon Simple Storage Service (Amazon S3) directory or bucket containing data files.- Parameters:
dataLocationS3
- The location of the data file(s) used by aDataSource
. The URI specifies a data file or an Amazon Simple Storage Service (Amazon S3) directory or bucket containing data files.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataRearrangement
A JSON string that represents the splitting and rearrangement processing to be applied to a
DataSource
. If theDataRearrangement
parameter is not provided, all of the input data is used to create theDatasource
.There are multiple parameters that control what data is used to create a datasource:
-
percentBegin
Use
percentBegin
to indicate the beginning of the range of the data used to create the Datasource. If you do not includepercentBegin
andpercentEnd
, Amazon ML includes all of the data when creating the datasource. -
percentEnd
Use
percentEnd
to indicate the end of the range of the data used to create the Datasource. If you do not includepercentBegin
andpercentEnd
, Amazon ML includes all of the data when creating the datasource. -
complement
The
complement
parameter instructs Amazon ML to use the data that is not included in the range ofpercentBegin
topercentEnd
to create a datasource. Thecomplement
parameter is useful if you need to create complementary datasources for training and evaluation. To create a complementary datasource, use the same values forpercentBegin
andpercentEnd
, along with thecomplement
parameter.For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.
Datasource for evaluation:
{"splitting":{"percentBegin":0, "percentEnd":25}}
Datasource for training:
{"splitting":{"percentBegin":0, "percentEnd":25, "complement":"true"}}
-
strategy
To change how Amazon ML splits the data for a datasource, use the
strategy
parameter.The default value for the
strategy
parameter issequential
, meaning that Amazon ML takes all of the data records between thepercentBegin
andpercentEnd
parameters for the datasource, in the order that the records appear in the input data.The following two
DataRearrangement
lines are examples of sequentially ordered training and evaluation datasources:Datasource for evaluation:
{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential"}}
Datasource for training:
{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential", "complement":"true"}}
To randomly split the input data into the proportions indicated by the percentBegin and percentEnd parameters, set the
strategy
parameter torandom
and provide a string that is used as the seed value for the random data splitting (for example, you can use the S3 path to your data as the random seed string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned number betweenpercentBegin
andpercentEnd
. Pseudo-random numbers are assigned using both the input seed string value and the byte offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly. It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in training and evaluation datasources containing non-similar data records.The following two
DataRearrangement
lines are examples of non-sequentially ordered training and evaluation datasources:Datasource for evaluation:
{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv"}}
Datasource for training:
{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv", "complement":"true"}}
- Parameters:
dataRearrangement
- A JSON string that represents the splitting and rearrangement processing to be applied to aDataSource
. If theDataRearrangement
parameter is not provided, all of the input data is used to create theDatasource
.There are multiple parameters that control what data is used to create a datasource:
-
percentBegin
Use
percentBegin
to indicate the beginning of the range of the data used to create the Datasource. If you do not includepercentBegin
andpercentEnd
, Amazon ML includes all of the data when creating the datasource. -
percentEnd
Use
percentEnd
to indicate the end of the range of the data used to create the Datasource. If you do not includepercentBegin
andpercentEnd
, Amazon ML includes all of the data when creating the datasource. -
complement
The
complement
parameter instructs Amazon ML to use the data that is not included in the range ofpercentBegin
topercentEnd
to create a datasource. Thecomplement
parameter is useful if you need to create complementary datasources for training and evaluation. To create a complementary datasource, use the same values forpercentBegin
andpercentEnd
, along with thecomplement
parameter.For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.
Datasource for evaluation:
{"splitting":{"percentBegin":0, "percentEnd":25}}
Datasource for training:
{"splitting":{"percentBegin":0, "percentEnd":25, "complement":"true"}}
-
strategy
To change how Amazon ML splits the data for a datasource, use the
strategy
parameter.The default value for the
strategy
parameter issequential
, meaning that Amazon ML takes all of the data records between thepercentBegin
andpercentEnd
parameters for the datasource, in the order that the records appear in the input data.The following two
DataRearrangement
lines are examples of sequentially ordered training and evaluation datasources:Datasource for evaluation:
{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential"}}
Datasource for training:
{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential", "complement":"true"}}
To randomly split the input data into the proportions indicated by the percentBegin and percentEnd parameters, set the
strategy
parameter torandom
and provide a string that is used as the seed value for the random data splitting (for example, you can use the S3 path to your data as the random seed string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned number betweenpercentBegin
andpercentEnd
. Pseudo-random numbers are assigned using both the input seed string value and the byte offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly. It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in training and evaluation datasources containing non-similar data records.The following two
DataRearrangement
lines are examples of non-sequentially ordered training and evaluation datasources:Datasource for evaluation:
{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv"}}
Datasource for training:
{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv", "complement":"true"}}
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
dataSchema
A JSON string that represents the schema for an Amazon S3
DataSource
. TheDataSchema
defines the structure of the observation data in the data file(s) referenced in theDataSource
.You must provide either the
DataSchema
or theDataSchemaLocationS3
.Define your
DataSchema
as a series of key-value pairs.attributes
andexcludedVariableNames
have an array of key-value pairs for their value. Use the following format to define yourDataSchema
.{ "version": "1.0",
"recordAnnotationFieldName": "F1",
"recordWeightFieldName": "F2",
"targetFieldName": "F3",
"dataFormat": "CSV",
"dataFileContainsHeader": true,
"attributes": [
{ "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],
"excludedVariableNames": [ "F6" ] }
- Parameters:
dataSchema
- A JSON string that represents the schema for an Amazon S3DataSource
. TheDataSchema
defines the structure of the observation data in the data file(s) referenced in theDataSource
.You must provide either the
DataSchema
or theDataSchemaLocationS3
.Define your
DataSchema
as a series of key-value pairs.attributes
andexcludedVariableNames
have an array of key-value pairs for their value. Use the following format to define yourDataSchema
.{ "version": "1.0",
"recordAnnotationFieldName": "F1",
"recordWeightFieldName": "F2",
"targetFieldName": "F3",
"dataFormat": "CSV",
"dataFileContainsHeader": true,
"attributes": [
{ "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],
"excludedVariableNames": [ "F6" ] }
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataSchemaLocationS3
Describes the schema location in Amazon S3. You must provide either the
DataSchema
or theDataSchemaLocationS3
.- Parameters:
dataSchemaLocationS3
- Describes the schema location in Amazon S3. You must provide either theDataSchema
or theDataSchemaLocationS3
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-