aws-sdk-sagemaker 1.100.0 → 1.104.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -260,7 +260,7 @@ module Aws::SageMaker
260
260
  # {
261
261
  # training_image: "AlgorithmImage",
262
262
  # algorithm_name: "ArnOrName",
263
- # training_input_mode: "Pipe", # required, accepts Pipe, File
263
+ # training_input_mode: "Pipe", # required, accepts Pipe, File, FastFile
264
264
  # metric_definitions: [
265
265
  # {
266
266
  # name: "MetricName", # required
@@ -293,27 +293,45 @@ module Aws::SageMaker
293
293
  # @return [String]
294
294
  #
295
295
  # @!attribute [rw] training_input_mode
296
- # The input mode that the algorithm supports. For the input modes that
297
- # Amazon SageMaker algorithms support, see [Algorithms][1]. If an
298
- # algorithm supports the `File` input mode, Amazon SageMaker downloads
299
- # the training data from S3 to the provisioned ML storage Volume, and
300
- # mounts the directory to docker volume for training container. If an
301
- # algorithm supports the `Pipe` input mode, Amazon SageMaker streams
302
- # data directly from S3 to the container.
303
- #
304
- # In File mode, make sure you provision ML storage volume with
305
- # sufficient capacity to accommodate the data download from S3. In
306
- # addition to the training data, the ML storage volume also stores the
307
- # output model. The algorithm container use ML storage volume to also
308
- # store intermediate information, if any.
309
- #
310
- # For distributed algorithms using File mode, training data is
311
- # distributed uniformly, and your training duration is predictable if
312
- # the input data objects size is approximately same. Amazon SageMaker
313
- # does not split the files any further for model training. If the
314
- # object sizes are skewed, training won't be optimal as the data
315
- # distribution is also skewed where one host in a training cluster is
316
- # overloaded, thus becoming bottleneck in training.
296
+ # The training input mode that the algorithm supports. For more
297
+ # information about input modes, see [Algorithms][1].
298
+ #
299
+ # **Pipe mode**
300
+ #
301
+ # If an algorithm supports `Pipe` mode, Amazon SageMaker streams data
302
+ # directly from Amazon S3 to the container.
303
+ #
304
+ # **File mode**
305
+ #
306
+ # If an algorithm supports `File` mode, SageMaker downloads the
307
+ # training data from S3 to the provisioned ML storage volume, and
308
+ # mounts the directory to the Docker volume for the training
309
+ # container.
310
+ #
311
+ # You must provision the ML storage volume with sufficient capacity to
312
+ # accommodate the data downloaded from S3. In addition to the training
313
+ # data, the ML storage volume also stores the output model. The
314
+ # algorithm container uses the ML storage volume to also store
315
+ # intermediate information, if any.
316
+ #
317
+ # For distributed algorithms, training data is distributed uniformly.
318
+ # Your training duration is predictable if the input data objects
319
+ # sizes are approximately the same. SageMaker does not split the files
320
+ # any further for model training. If the object sizes are skewed,
321
+ # training won't be optimal as the data distribution is also skewed
322
+ # when one host in a training cluster is overloaded, thus becoming a
323
+ # bottleneck in training.
324
+ #
325
+ # **FastFile mode**
326
+ #
327
+ # If an algorithm supports `FastFile` mode, SageMaker streams data
328
+ # directly from S3 to the container with no code changes, and provides
329
+ # file system access to the data. Users can author their training
330
+ # script to interact with these files as if they were stored on disk.
331
+ #
332
+ # `FastFile` mode works best when the data is read sequentially.
333
+ # Augmented manifest files aren't supported. The startup time is
334
+ # lower when there are fewer files in the S3 bucket provided.
317
335
  #
318
336
  #
319
337
  #
@@ -451,7 +469,7 @@ module Aws::SageMaker
451
469
  # {
452
470
  # profile_name: "EntityName", # required
453
471
  # training_job_definition: { # required
454
- # training_input_mode: "Pipe", # required, accepts Pipe, File
472
+ # training_input_mode: "Pipe", # required, accepts Pipe, File, FastFile
455
473
  # hyper_parameters: {
456
474
  # "HyperParameterKey" => "HyperParameterValue",
457
475
  # },
@@ -475,7 +493,7 @@ module Aws::SageMaker
475
493
  # content_type: "ContentType",
476
494
  # compression_type: "None", # accepts None, Gzip
477
495
  # record_wrapper_type: "None", # accepts None, RecordIO
478
- # input_mode: "Pipe", # accepts Pipe, File
496
+ # input_mode: "Pipe", # accepts Pipe, File, FastFile
479
497
  # shuffle_config: {
480
498
  # seed: 1, # required
481
499
  # },
@@ -565,7 +583,7 @@ module Aws::SageMaker
565
583
  # {
566
584
  # profile_name: "EntityName", # required
567
585
  # training_job_definition: { # required
568
- # training_input_mode: "Pipe", # required, accepts Pipe, File
586
+ # training_input_mode: "Pipe", # required, accepts Pipe, File, FastFile
569
587
  # hyper_parameters: {
570
588
  # "HyperParameterKey" => "HyperParameterValue",
571
589
  # },
@@ -589,7 +607,7 @@ module Aws::SageMaker
589
607
  # content_type: "ContentType",
590
608
  # compression_type: "None", # accepts None, Gzip
591
609
  # record_wrapper_type: "None", # accepts None, RecordIO
592
- # input_mode: "Pipe", # accepts Pipe, File
610
+ # input_mode: "Pipe", # accepts Pipe, File, FastFile
593
611
  # shuffle_config: {
594
612
  # seed: 1, # required
595
613
  # },
@@ -1622,7 +1640,7 @@ module Aws::SageMaker
1622
1640
  #
1623
1641
  # @!attribute [rw] created_by
1624
1642
  # Information about the user who created or modified an experiment,
1625
- # trial, or trial component.
1643
+ # trial, trial component, or project.
1626
1644
  # @return [Types::UserContext]
1627
1645
  #
1628
1646
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/AssociationSummary AWS API Documentation
@@ -2063,12 +2081,20 @@ module Aws::SageMaker
2063
2081
  # @return [Integer]
2064
2082
  #
2065
2083
  # @!attribute [rw] max_runtime_per_training_job_in_seconds
2066
- # The maximum time, in seconds, a training job is allowed to run as
2067
- # part of an AutoML job.
2084
+ # The maximum time, in seconds, that each training job is allowed to
2085
+ # run as part of a hyperparameter tuning job. For more information,
2086
+ # see the used by the action.
2068
2087
  # @return [Integer]
2069
2088
  #
2070
2089
  # @!attribute [rw] max_auto_ml_job_runtime_in_seconds
2071
2090
  # The maximum runtime, in seconds, an AutoML job has to complete.
2091
+ #
2092
+ # If an AutoML job exceeds the maximum runtime, the job is stopped
2093
+ # automatically and its processing is ended gracefully. The AutoML job
2094
+ # identifies the best model whose training was completed and marks it
2095
+ # as the best-performing model. Any unfinished steps of the job, such
2096
+ # as automatic one-click Autopilot model deployment, will not be
2097
+ # completed.
2072
2098
  # @return [Integer]
2073
2099
  #
2074
2100
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/AutoMLJobCompletionCriteria AWS API Documentation
@@ -2676,7 +2702,7 @@ module Aws::SageMaker
2676
2702
  # content_type: "ContentType",
2677
2703
  # compression_type: "None", # accepts None, Gzip
2678
2704
  # record_wrapper_type: "None", # accepts None, RecordIO
2679
- # input_mode: "Pipe", # accepts Pipe, File
2705
+ # input_mode: "Pipe", # accepts Pipe, File, FastFile
2680
2706
  # shuffle_config: {
2681
2707
  # seed: 1, # required
2682
2708
  # },
@@ -2775,7 +2801,7 @@ module Aws::SageMaker
2775
2801
  # is_required: false,
2776
2802
  # supported_content_types: ["ContentType"], # required
2777
2803
  # supported_compression_types: ["None"], # accepts None, Gzip
2778
- # supported_input_modes: ["Pipe"], # required, accepts Pipe, File
2804
+ # supported_input_modes: ["Pipe"], # required, accepts Pipe, File, FastFile
2779
2805
  # }
2780
2806
  #
2781
2807
  # @!attribute [rw] name
@@ -3549,7 +3575,7 @@ module Aws::SageMaker
3549
3575
  # is_required: false,
3550
3576
  # supported_content_types: ["ContentType"], # required
3551
3577
  # supported_compression_types: ["None"], # accepts None, Gzip
3552
- # supported_input_modes: ["Pipe"], # required, accepts Pipe, File
3578
+ # supported_input_modes: ["Pipe"], # required, accepts Pipe, File, FastFile
3553
3579
  # },
3554
3580
  # ],
3555
3581
  # supported_tuning_job_objective_metrics: [
@@ -3583,7 +3609,7 @@ module Aws::SageMaker
3583
3609
  # {
3584
3610
  # profile_name: "EntityName", # required
3585
3611
  # training_job_definition: { # required
3586
- # training_input_mode: "Pipe", # required, accepts Pipe, File
3612
+ # training_input_mode: "Pipe", # required, accepts Pipe, File, FastFile
3587
3613
  # hyper_parameters: {
3588
3614
  # "HyperParameterKey" => "HyperParameterValue",
3589
3615
  # },
@@ -3607,7 +3633,7 @@ module Aws::SageMaker
3607
3633
  # content_type: "ContentType",
3608
3634
  # compression_type: "None", # accepts None, Gzip
3609
3635
  # record_wrapper_type: "None", # accepts None, RecordIO
3610
- # input_mode: "Pipe", # accepts Pipe, File
3636
+ # input_mode: "Pipe", # accepts Pipe, File, FastFile
3611
3637
  # shuffle_config: {
3612
3638
  # seed: 1, # required
3613
3639
  # },
@@ -5255,12 +5281,19 @@ module Aws::SageMaker
5255
5281
  # `OfflineStore`.
5256
5282
  #
5257
5283
  # * A configuration for an Amazon Web Services Glue or Amazon Web
5258
- # Services Hive data cataolgue.
5284
+ # Services Hive data catalog.
5259
5285
  #
5260
5286
  # * An KMS encryption key to encrypt the Amazon S3 location used for
5261
- # `OfflineStore`.
5287
+ # `OfflineStore`. If KMS encryption key is not specified, by default
5288
+ # we encrypt all data at rest using Amazon Web Services KMS key. By
5289
+ # defining your [bucket-level key][1] for SSE, you can reduce Amazon
5290
+ # Web Services KMS requests costs by up to 99 percent.
5262
5291
  #
5263
5292
  # To learn more about this parameter, see OfflineStoreConfig.
5293
+ #
5294
+ #
5295
+ #
5296
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-key.html
5264
5297
  # @return [Types::OfflineStoreConfig]
5265
5298
  #
5266
5299
  # @!attribute [rw] role_arn
@@ -5544,7 +5577,7 @@ module Aws::SageMaker
5544
5577
  # },
5545
5578
  # algorithm_specification: { # required
5546
5579
  # training_image: "AlgorithmImage",
5547
- # training_input_mode: "Pipe", # required, accepts Pipe, File
5580
+ # training_input_mode: "Pipe", # required, accepts Pipe, File, FastFile
5548
5581
  # algorithm_name: "ArnOrName",
5549
5582
  # metric_definitions: [
5550
5583
  # {
@@ -5574,7 +5607,7 @@ module Aws::SageMaker
5574
5607
  # content_type: "ContentType",
5575
5608
  # compression_type: "None", # accepts None, Gzip
5576
5609
  # record_wrapper_type: "None", # accepts None, RecordIO
5577
- # input_mode: "Pipe", # accepts Pipe, File
5610
+ # input_mode: "Pipe", # accepts Pipe, File, FastFile
5578
5611
  # shuffle_config: {
5579
5612
  # seed: 1, # required
5580
5613
  # },
@@ -5645,7 +5678,7 @@ module Aws::SageMaker
5645
5678
  # },
5646
5679
  # algorithm_specification: { # required
5647
5680
  # training_image: "AlgorithmImage",
5648
- # training_input_mode: "Pipe", # required, accepts Pipe, File
5681
+ # training_input_mode: "Pipe", # required, accepts Pipe, File, FastFile
5649
5682
  # algorithm_name: "ArnOrName",
5650
5683
  # metric_definitions: [
5651
5684
  # {
@@ -5675,7 +5708,7 @@ module Aws::SageMaker
5675
5708
  # content_type: "ContentType",
5676
5709
  # compression_type: "None", # accepts None, Gzip
5677
5710
  # record_wrapper_type: "None", # accepts None, RecordIO
5678
- # input_mode: "Pipe", # accepts Pipe, File
5711
+ # input_mode: "Pipe", # accepts Pipe, File, FastFile
5679
5712
  # shuffle_config: {
5680
5713
  # seed: 1, # required
5681
5714
  # },
@@ -7906,7 +7939,7 @@ module Aws::SageMaker
7906
7939
  # project_description: "EntityDescription",
7907
7940
  # service_catalog_provisioning_details: { # required
7908
7941
  # product_id: "ServiceCatalogEntityId", # required
7909
- # provisioning_artifact_id: "ServiceCatalogEntityId", # required
7942
+ # provisioning_artifact_id: "ServiceCatalogEntityId",
7910
7943
  # path_id: "ServiceCatalogEntityId",
7911
7944
  # provisioning_parameters: [
7912
7945
  # {
@@ -7933,8 +7966,10 @@ module Aws::SageMaker
7933
7966
  #
7934
7967
  # @!attribute [rw] service_catalog_provisioning_details
7935
7968
  # The product ID and provisioning artifact ID to provision a service
7936
- # catalog. For information, see [What is Amazon Web Services Service
7937
- # Catalog][1].
7969
+ # catalog. The provisioning artifact ID will default to the latest
7970
+ # provisioning artifact ID of the product, if you don't provide the
7971
+ # provisioning artifact ID. For more information, see [What is Amazon
7972
+ # Web Services Service Catalog][1].
7938
7973
  #
7939
7974
  #
7940
7975
  #
@@ -8048,7 +8083,7 @@ module Aws::SageMaker
8048
8083
  # algorithm_specification: { # required
8049
8084
  # training_image: "AlgorithmImage",
8050
8085
  # algorithm_name: "ArnOrName",
8051
- # training_input_mode: "Pipe", # required, accepts Pipe, File
8086
+ # training_input_mode: "Pipe", # required, accepts Pipe, File, FastFile
8052
8087
  # metric_definitions: [
8053
8088
  # {
8054
8089
  # name: "MetricName", # required
@@ -8078,7 +8113,7 @@ module Aws::SageMaker
8078
8113
  # content_type: "ContentType",
8079
8114
  # compression_type: "None", # accepts None, Gzip
8080
8115
  # record_wrapper_type: "None", # accepts None, RecordIO
8081
- # input_mode: "Pipe", # accepts Pipe, File
8116
+ # input_mode: "Pipe", # accepts Pipe, File, FastFile
8082
8117
  # shuffle_config: {
8083
8118
  # seed: 1, # required
8084
8119
  # },
@@ -9383,19 +9418,18 @@ module Aws::SageMaker
9383
9418
  # specify `OutputFilter` as an additional filter to select a portion
9384
9419
  # of the joined dataset and store it in the output file.
9385
9420
  #
9386
- # For JSON or JSONLines objects, such as a JSON array, Amazon
9387
- # SageMaker adds the transformed data to the input JSON object in an
9388
- # attribute called `SageMakerOutput`. The joined result for JSON must
9389
- # be a key-value pair object. If the input is not a key-value pair
9390
- # object, Amazon SageMaker creates a new JSON file. In the new JSON
9391
- # file, and the input data is stored under the `SageMakerInput` key
9392
- # and the results are stored in `SageMakerOutput`.
9421
+ # For JSON or JSONLines objects, such as a JSON array, SageMaker adds
9422
+ # the transformed data to the input JSON object in an attribute called
9423
+ # `SageMakerOutput`. The joined result for JSON must be a key-value
9424
+ # pair object. If the input is not a key-value pair object, SageMaker
9425
+ # creates a new JSON file. In the new JSON file, and the input data is
9426
+ # stored under the `SageMakerInput` key and the results are stored in
9427
+ # `SageMakerOutput`.
9393
9428
  #
9394
- # For CSV data, Amazon SageMaker takes each row as a JSON array and
9395
- # joins the transformed data with the input by appending each
9396
- # transformed row to the end of the input. The joined data has the
9397
- # original input data followed by the transformed data and the output
9398
- # is a CSV file.
9429
+ # For CSV data, SageMaker takes each row as a JSON array and joins the
9430
+ # transformed data with the input by appending each transformed row to
9431
+ # the end of the input. The joined data has the original input data
9432
+ # followed by the transformed data and the output is a CSV file.
9399
9433
  #
9400
9434
  # For information on how joining in applied, see [Workflow for
9401
9435
  # Associating Inferences with Input Records][1].
@@ -10936,7 +10970,7 @@ module Aws::SageMaker
10936
10970
  #
10937
10971
  # @!attribute [rw] created_by
10938
10972
  # Information about the user who created or modified an experiment,
10939
- # trial, or trial component.
10973
+ # trial, trial component, or project.
10940
10974
  # @return [Types::UserContext]
10941
10975
  #
10942
10976
  # @!attribute [rw] last_modified_time
@@ -10945,7 +10979,7 @@ module Aws::SageMaker
10945
10979
  #
10946
10980
  # @!attribute [rw] last_modified_by
10947
10981
  # Information about the user who created or modified an experiment,
10948
- # trial, or trial component.
10982
+ # trial, trial component, or project.
10949
10983
  # @return [Types::UserContext]
10950
10984
  #
10951
10985
  # @!attribute [rw] metadata_properties
@@ -11173,6 +11207,9 @@ module Aws::SageMaker
11173
11207
  #
11174
11208
  # @!attribute [rw] last_user_activity_timestamp
11175
11209
  # The timestamp of the last user's activity.
11210
+ # `LastUserActivityTimestamp` is also updated when SageMaker performs
11211
+ # health checks without user activity. As a result, this value is set
11212
+ # to the same value as `LastHealthCheckTimestamp`.
11176
11213
  # @return [Time]
11177
11214
  #
11178
11215
  # @!attribute [rw] creation_time
@@ -11251,7 +11288,7 @@ module Aws::SageMaker
11251
11288
  #
11252
11289
  # @!attribute [rw] created_by
11253
11290
  # Information about the user who created or modified an experiment,
11254
- # trial, or trial component.
11291
+ # trial, trial component, or project.
11255
11292
  # @return [Types::UserContext]
11256
11293
  #
11257
11294
  # @!attribute [rw] last_modified_time
@@ -11260,7 +11297,7 @@ module Aws::SageMaker
11260
11297
  #
11261
11298
  # @!attribute [rw] last_modified_by
11262
11299
  # Information about the user who created or modified an experiment,
11263
- # trial, or trial component.
11300
+ # trial, trial component, or project.
11264
11301
  # @return [Types::UserContext]
11265
11302
  #
11266
11303
  # @!attribute [rw] metadata_properties
@@ -11662,7 +11699,7 @@ module Aws::SageMaker
11662
11699
  #
11663
11700
  # @!attribute [rw] created_by
11664
11701
  # Information about the user who created or modified an experiment,
11665
- # trial, or trial component.
11702
+ # trial, trial component, or project.
11666
11703
  # @return [Types::UserContext]
11667
11704
  #
11668
11705
  # @!attribute [rw] last_modified_time
@@ -11671,7 +11708,7 @@ module Aws::SageMaker
11671
11708
  #
11672
11709
  # @!attribute [rw] last_modified_by
11673
11710
  # Information about the user who created or modified an experiment,
11674
- # trial, or trial component.
11711
+ # trial, trial component, or project.
11675
11712
  # @return [Types::UserContext]
11676
11713
  #
11677
11714
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeContextResponse AWS API Documentation
@@ -13419,7 +13456,7 @@ module Aws::SageMaker
13419
13456
  #
13420
13457
  # @!attribute [rw] created_by
13421
13458
  # Information about the user who created or modified an experiment,
13422
- # trial, or trial component.
13459
+ # trial, trial component, or project.
13423
13460
  # @return [Types::UserContext]
13424
13461
  #
13425
13462
  # @!attribute [rw] model_package_group_status
@@ -13521,7 +13558,7 @@ module Aws::SageMaker
13521
13558
  #
13522
13559
  # @!attribute [rw] created_by
13523
13560
  # Information about the user who created or modified an experiment,
13524
- # trial, or trial component.
13561
+ # trial, trial component, or project.
13525
13562
  # @return [Types::UserContext]
13526
13563
  #
13527
13564
  # @!attribute [rw] metadata_properties
@@ -13539,7 +13576,7 @@ module Aws::SageMaker
13539
13576
  #
13540
13577
  # @!attribute [rw] last_modified_by
13541
13578
  # Information about the user who created or modified an experiment,
13542
- # trial, or trial component.
13579
+ # trial, trial component, or project.
13543
13580
  # @return [Types::UserContext]
13544
13581
  #
13545
13582
  # @!attribute [rw] approval_description
@@ -14098,12 +14135,12 @@ module Aws::SageMaker
14098
14135
  #
14099
14136
  # @!attribute [rw] created_by
14100
14137
  # Information about the user who created or modified an experiment,
14101
- # trial, or trial component.
14138
+ # trial, trial component, or project.
14102
14139
  # @return [Types::UserContext]
14103
14140
  #
14104
14141
  # @!attribute [rw] last_modified_by
14105
14142
  # Information about the user who created or modified an experiment,
14106
- # trial, or trial component.
14143
+ # trial, trial component, or project.
14107
14144
  # @return [Types::UserContext]
14108
14145
  #
14109
14146
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribePipelineExecutionResponse AWS API Documentation
@@ -14185,12 +14222,12 @@ module Aws::SageMaker
14185
14222
  #
14186
14223
  # @!attribute [rw] created_by
14187
14224
  # Information about the user who created or modified an experiment,
14188
- # trial, or trial component.
14225
+ # trial, trial component, or project.
14189
14226
  # @return [Types::UserContext]
14190
14227
  #
14191
14228
  # @!attribute [rw] last_modified_by
14192
14229
  # Information about the user who created or modified an experiment,
14193
- # trial, or trial component.
14230
+ # trial, trial component, or project.
14194
14231
  # @return [Types::UserContext]
14195
14232
  #
14196
14233
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribePipelineResponse AWS API Documentation
@@ -14405,7 +14442,7 @@ module Aws::SageMaker
14405
14442
  #
14406
14443
  # @!attribute [rw] created_by
14407
14444
  # Information about the user who created or modified an experiment,
14408
- # trial, or trial component.
14445
+ # trial, trial component, or project.
14409
14446
  # @return [Types::UserContext]
14410
14447
  #
14411
14448
  # @!attribute [rw] creation_time
@@ -14777,8 +14814,8 @@ module Aws::SageMaker
14777
14814
  #
14778
14815
  # Multiply `BillableTimeInSeconds` by the number of instances
14779
14816
  # (`InstanceCount`) in your training cluster to get the total compute
14780
- # time Amazon SageMaker will bill you if you run distributed training.
14781
- # The formula is as follows: `BillableTimeInSeconds * InstanceCount` .
14817
+ # time SageMaker will bill you if you run distributed training. The
14818
+ # formula is as follows: `BillableTimeInSeconds * InstanceCount` .
14782
14819
  #
14783
14820
  # You can calculate the savings from using managed spot training using
14784
14821
  # the formula `(1 - BillableTimeInSeconds / TrainingTimeInSeconds) *
@@ -15127,7 +15164,7 @@ module Aws::SageMaker
15127
15164
  # @return [Time]
15128
15165
  #
15129
15166
  # @!attribute [rw] created_by
15130
- # Who created the component.
15167
+ # Who created the trial component.
15131
15168
  # @return [Types::UserContext]
15132
15169
  #
15133
15170
  # @!attribute [rw] last_modified_time
@@ -16072,7 +16109,7 @@ module Aws::SageMaker
16072
16109
  #
16073
16110
  # @!attribute [rw] s3_input_mode
16074
16111
  # Whether the `Pipe` or `File` is used as the input mode for
16075
- # transfering data for the monitoring job. `Pipe` mode is recommended
16112
+ # transferring data for the monitoring job. `Pipe` mode is recommended
16076
16113
  # for large datasets. `File` mode is useful for small files that fit
16077
16114
  # in memory. Defaults to `File`.
16078
16115
  # @return [String]
@@ -16235,8 +16272,7 @@ module Aws::SageMaker
16235
16272
  # @return [Time]
16236
16273
  #
16237
16274
  # @!attribute [rw] created_by
16238
- # Information about the user who created or modified an experiment,
16239
- # trial, or trial component.
16275
+ # Who created the experiment.
16240
16276
  # @return [Types::UserContext]
16241
16277
  #
16242
16278
  # @!attribute [rw] last_modified_time
@@ -16245,7 +16281,7 @@ module Aws::SageMaker
16245
16281
  #
16246
16282
  # @!attribute [rw] last_modified_by
16247
16283
  # Information about the user who created or modified an experiment,
16248
- # trial, or trial component.
16284
+ # trial, trial component, or project.
16249
16285
  # @return [Types::UserContext]
16250
16286
  #
16251
16287
  # @!attribute [rw] tags
@@ -18384,7 +18420,7 @@ module Aws::SageMaker
18384
18420
  #
18385
18421
  # {
18386
18422
  # training_image: "AlgorithmImage",
18387
- # training_input_mode: "Pipe", # required, accepts Pipe, File
18423
+ # training_input_mode: "Pipe", # required, accepts Pipe, File, FastFile
18388
18424
  # algorithm_name: "ArnOrName",
18389
18425
  # metric_definitions: [
18390
18426
  # {
@@ -18410,21 +18446,45 @@ module Aws::SageMaker
18410
18446
  # @return [String]
18411
18447
  #
18412
18448
  # @!attribute [rw] training_input_mode
18413
- # The input mode that the algorithm supports: File or Pipe. In File
18414
- # input mode, Amazon SageMaker downloads the training data from Amazon
18415
- # S3 to the storage volume that is attached to the training instance
18416
- # and mounts the directory to the Docker volume for the training
18417
- # container. In Pipe input mode, Amazon SageMaker streams data
18449
+ # The training input mode that the algorithm supports. For more
18450
+ # information about input modes, see [Algorithms][1].
18451
+ #
18452
+ # **Pipe mode**
18453
+ #
18454
+ # If an algorithm supports `Pipe` mode, Amazon SageMaker streams data
18418
18455
  # directly from Amazon S3 to the container.
18419
18456
  #
18420
- # If you specify File mode, make sure that you provision the storage
18421
- # volume that is attached to the training instance with enough
18422
- # capacity to accommodate the training data downloaded from Amazon S3,
18423
- # the model artifacts, and intermediate information.
18457
+ # **File mode**
18458
+ #
18459
+ # If an algorithm supports `File` mode, SageMaker downloads the
18460
+ # training data from S3 to the provisioned ML storage volume, and
18461
+ # mounts the directory to the Docker volume for the training
18462
+ # container.
18463
+ #
18464
+ # You must provision the ML storage volume with sufficient capacity to
18465
+ # accommodate the data downloaded from S3. In addition to the training
18466
+ # data, the ML storage volume also stores the output model. The
18467
+ # algorithm container uses the ML storage volume to also store
18468
+ # intermediate information, if any.
18469
+ #
18470
+ # For distributed algorithms, training data is distributed uniformly.
18471
+ # Your training duration is predictable if the input data objects
18472
+ # sizes are approximately the same. SageMaker does not split the files
18473
+ # any further for model training. If the object sizes are skewed,
18474
+ # training won't be optimal as the data distribution is also skewed
18475
+ # when one host in a training cluster is overloaded, thus becoming a
18476
+ # bottleneck in training.
18424
18477
  #
18478
+ # **FastFile mode**
18425
18479
  #
18480
+ # If an algorithm supports `FastFile` mode, SageMaker streams data
18481
+ # directly from S3 to the container with no code changes, and provides
18482
+ # file system access to the data. Users can author their training
18483
+ # script to interact with these files as if they were stored on disk.
18426
18484
  #
18427
- # For more information about input modes, see [Algorithms][1].
18485
+ # `FastFile` mode works best when the data is read sequentially.
18486
+ # Augmented manifest files aren't supported. The startup time is
18487
+ # lower when there are fewer files in the S3 bucket provided.
18428
18488
  #
18429
18489
  #
18430
18490
  #
@@ -18565,7 +18625,7 @@ module Aws::SageMaker
18565
18625
  # },
18566
18626
  # algorithm_specification: { # required
18567
18627
  # training_image: "AlgorithmImage",
18568
- # training_input_mode: "Pipe", # required, accepts Pipe, File
18628
+ # training_input_mode: "Pipe", # required, accepts Pipe, File, FastFile
18569
18629
  # algorithm_name: "ArnOrName",
18570
18630
  # metric_definitions: [
18571
18631
  # {
@@ -18595,7 +18655,7 @@ module Aws::SageMaker
18595
18655
  # content_type: "ContentType",
18596
18656
  # compression_type: "None", # accepts None, Gzip
18597
18657
  # record_wrapper_type: "None", # accepts None, RecordIO
18598
- # input_mode: "Pipe", # accepts Pipe, File
18658
+ # input_mode: "Pipe", # accepts Pipe, File, FastFile
18599
18659
  # shuffle_config: {
18600
18660
  # seed: 1, # required
18601
18661
  # },
@@ -25297,7 +25357,7 @@ module Aws::SageMaker
25297
25357
  # model artifacts.
25298
25358
  #
25299
25359
  # Model artifacts are the output that results from training a model, and
25300
- # typically consist of trained parameters, a model defintion that
25360
+ # typically consist of trained parameters, a model definition that
25301
25361
  # describes how to compute inferences, and other metadata.
25302
25362
  #
25303
25363
  # @!attribute [rw] s3_model_artifacts
@@ -25824,7 +25884,7 @@ module Aws::SageMaker
25824
25884
  #
25825
25885
  # @!attribute [rw] created_by
25826
25886
  # Information about the user who created or modified an experiment,
25827
- # trial, or trial component.
25887
+ # trial, trial component, or project.
25828
25888
  # @return [Types::UserContext]
25829
25889
  #
25830
25890
  # @!attribute [rw] metadata_properties
@@ -25842,7 +25902,7 @@ module Aws::SageMaker
25842
25902
  #
25843
25903
  # @!attribute [rw] last_modified_by
25844
25904
  # Information about the user who created or modified an experiment,
25845
- # trial, or trial component.
25905
+ # trial, trial component, or project.
25846
25906
  # @return [Types::UserContext]
25847
25907
  #
25848
25908
  # @!attribute [rw] approval_description
@@ -25981,7 +26041,7 @@ module Aws::SageMaker
25981
26041
  #
25982
26042
  # @!attribute [rw] created_by
25983
26043
  # Information about the user who created or modified an experiment,
25984
- # trial, or trial component.
26044
+ # trial, trial component, or project.
25985
26045
  # @return [Types::UserContext]
25986
26046
  #
25987
26047
  # @!attribute [rw] model_package_group_status
@@ -28654,12 +28714,12 @@ module Aws::SageMaker
28654
28714
  #
28655
28715
  # @!attribute [rw] created_by
28656
28716
  # Information about the user who created or modified an experiment,
28657
- # trial, or trial component.
28717
+ # trial, trial component, or project.
28658
28718
  # @return [Types::UserContext]
28659
28719
  #
28660
28720
  # @!attribute [rw] last_modified_by
28661
28721
  # Information about the user who created or modified an experiment,
28662
- # trial, or trial component.
28722
+ # trial, trial component, or project.
28663
28723
  # @return [Types::UserContext]
28664
28724
  #
28665
28725
  # @!attribute [rw] tags
@@ -28726,12 +28786,12 @@ module Aws::SageMaker
28726
28786
  #
28727
28787
  # @!attribute [rw] created_by
28728
28788
  # Information about the user who created or modified an experiment,
28729
- # trial, or trial component.
28789
+ # trial, trial component, or project.
28730
28790
  # @return [Types::UserContext]
28731
28791
  #
28732
28792
  # @!attribute [rw] last_modified_by
28733
28793
  # Information about the user who created or modified an experiment,
28734
- # trial, or trial component.
28794
+ # trial, trial component, or project.
28735
28795
  # @return [Types::UserContext]
28736
28796
  #
28737
28797
  # @!attribute [rw] pipeline_parameters
@@ -30042,7 +30102,7 @@ module Aws::SageMaker
30042
30102
  #
30043
30103
  # @!attribute [rw] service_catalog_provisioning_details
30044
30104
  # Details that you specify to provision a service catalog product. For
30045
- # information about service catalog, see .[What is Amazon Web Services
30105
+ # information about service catalog, see [What is Amazon Web Services
30046
30106
  # Service Catalog][1].
30047
30107
  #
30048
30108
  #
@@ -30065,8 +30125,7 @@ module Aws::SageMaker
30065
30125
  # @return [String]
30066
30126
  #
30067
30127
  # @!attribute [rw] created_by
30068
- # Information about the user who created or modified an experiment,
30069
- # trial, or trial component.
30128
+ # Who created the project.
30070
30129
  # @return [Types::UserContext]
30071
30130
  #
30072
30131
  # @!attribute [rw] creation_time
@@ -31016,6 +31075,48 @@ module Aws::SageMaker
31016
31075
  include Aws::Structure
31017
31076
  end
31018
31077
 
31078
+ # @note When making an API call, you may pass RetryPipelineExecutionRequest
31079
+ # data as a hash:
31080
+ #
31081
+ # {
31082
+ # pipeline_execution_arn: "PipelineExecutionArn", # required
31083
+ # client_request_token: "IdempotencyToken", # required
31084
+ # }
31085
+ #
31086
+ # @!attribute [rw] pipeline_execution_arn
31087
+ # The Amazon Resource Name (ARN) of the pipeline execution.
31088
+ # @return [String]
31089
+ #
31090
+ # @!attribute [rw] client_request_token
31091
+ # A unique, case-sensitive identifier that you provide to ensure the
31092
+ # idempotency of the operation. An idempotent operation completes no
31093
+ # more than once.
31094
+ #
31095
+ # **A suitable default value is auto-generated.** You should normally
31096
+ # not need to pass this option.
31097
+ # @return [String]
31098
+ #
31099
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/RetryPipelineExecutionRequest AWS API Documentation
31100
+ #
31101
+ class RetryPipelineExecutionRequest < Struct.new(
31102
+ :pipeline_execution_arn,
31103
+ :client_request_token)
31104
+ SENSITIVE = []
31105
+ include Aws::Structure
31106
+ end
31107
+
31108
+ # @!attribute [rw] pipeline_execution_arn
31109
+ # The Amazon Resource Name (ARN) of the pipeline execution.
31110
+ # @return [String]
31111
+ #
31112
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/RetryPipelineExecutionResponse AWS API Documentation
31113
+ #
31114
+ class RetryPipelineExecutionResponse < Struct.new(
31115
+ :pipeline_execution_arn)
31116
+ SENSITIVE = []
31117
+ include Aws::Structure
31118
+ end
31119
+
31019
31120
  # The retry strategy to use when a training job fails due to an
31020
31121
  # `InternalServerError`. `RetryStrategy` is specified as part of the
31021
31122
  # `CreateTrainingJob` and `CreateHyperParameterTuningJob` requests. You
@@ -31812,7 +31913,7 @@ module Aws::SageMaker
31812
31913
  end
31813
31914
 
31814
31915
  # Details that you specify to provision a service catalog product. For
31815
- # information about service catalog, see .[What is Amazon Web Services
31916
+ # information about service catalog, see [What is Amazon Web Services
31816
31917
  # Service Catalog][1].
31817
31918
  #
31818
31919
  #
@@ -31824,7 +31925,7 @@ module Aws::SageMaker
31824
31925
  #
31825
31926
  # {
31826
31927
  # product_id: "ServiceCatalogEntityId", # required
31827
- # provisioning_artifact_id: "ServiceCatalogEntityId", # required
31928
+ # provisioning_artifact_id: "ServiceCatalogEntityId",
31828
31929
  # path_id: "ServiceCatalogEntityId",
31829
31930
  # provisioning_parameters: [
31830
31931
  # {
@@ -32120,7 +32221,7 @@ module Aws::SageMaker
32120
32221
  # @!attribute [rw] client_request_token
32121
32222
  # A unique, case-sensitive identifier that you provide to ensure the
32122
32223
  # idempotency of the operation. An idempotent operation completes no
32123
- # more than one time.
32224
+ # more than once.
32124
32225
  #
32125
32226
  # **A suitable default value is auto-generated.** You should normally
32126
32227
  # not need to pass this option.
@@ -32298,7 +32399,7 @@ module Aws::SageMaker
32298
32399
  # @!attribute [rw] client_request_token
32299
32400
  # A unique, case-sensitive identifier that you provide to ensure the
32300
32401
  # idempotency of the operation. An idempotent operation completes no
32301
- # more than one time.
32402
+ # more than once.
32302
32403
  #
32303
32404
  # **A suitable default value is auto-generated.** You should normally
32304
32405
  # not need to pass this option.
@@ -32382,11 +32483,11 @@ module Aws::SageMaker
32382
32483
  include Aws::Structure
32383
32484
  end
32384
32485
 
32385
- # Specifies a limit to how long a model training job, model compilation
32386
- # job, or hyperparameter tuning job can run. It also specifies how long
32387
- # a managed Spot training job has to complete. When the job reaches the
32388
- # time limit, Amazon SageMaker ends the training or compilation job. Use
32389
- # this API to cap model training costs.
32486
+ # Specifies a limit to how long a model training job or model
32487
+ # compilation job can run. It also specifies how long a managed spot
32488
+ # training job has to complete. When the job reaches the time limit,
32489
+ # Amazon SageMaker ends the training or compilation job. Use this API to
32490
+ # cap model training costs.
32390
32491
  #
32391
32492
  # To stop a training job, Amazon SageMaker sends the algorithm the
32392
32493
  # `SIGTERM` signal, which delays job termination for 120 seconds.
@@ -32548,12 +32649,12 @@ module Aws::SageMaker
32548
32649
  end
32549
32650
 
32550
32651
  # A tag object that consists of a key and an optional value, used to
32551
- # manage metadata for Amazon SageMaker Amazon Web Services resources.
32652
+ # manage metadata for SageMaker Amazon Web Services resources.
32552
32653
  #
32553
32654
  # You can add tags to notebook instances, training jobs, hyperparameter
32554
32655
  # tuning jobs, batch transform jobs, models, labeling jobs, work teams,
32555
32656
  # endpoint configurations, and endpoints. For more information on adding
32556
- # tags to Amazon SageMaker resources, see AddTags.
32657
+ # tags to SageMaker resources, see AddTags.
32557
32658
  #
32558
32659
  # For more information on adding metadata to your Amazon Web Services
32559
32660
  # resources with tagging, see [Tagging Amazon Web Services
@@ -33082,7 +33183,7 @@ module Aws::SageMaker
33082
33183
  # data as a hash:
33083
33184
  #
33084
33185
  # {
33085
- # training_input_mode: "Pipe", # required, accepts Pipe, File
33186
+ # training_input_mode: "Pipe", # required, accepts Pipe, File, FastFile
33086
33187
  # hyper_parameters: {
33087
33188
  # "HyperParameterKey" => "HyperParameterValue",
33088
33189
  # },
@@ -33106,7 +33207,7 @@ module Aws::SageMaker
33106
33207
  # content_type: "ContentType",
33107
33208
  # compression_type: "None", # accepts None, Gzip
33108
33209
  # record_wrapper_type: "None", # accepts None, RecordIO
33109
- # input_mode: "Pipe", # accepts Pipe, File
33210
+ # input_mode: "Pipe", # accepts Pipe, File, FastFile
33110
33211
  # shuffle_config: {
33111
33212
  # seed: 1, # required
33112
33213
  # },
@@ -33129,15 +33230,45 @@ module Aws::SageMaker
33129
33230
  # }
33130
33231
  #
33131
33232
  # @!attribute [rw] training_input_mode
33132
- # The input mode used by the algorithm for the training job. For the
33133
- # input modes that Amazon SageMaker algorithms support, see
33134
- # [Algorithms][1].
33233
+ # The training input mode that the algorithm supports. For more
33234
+ # information about input modes, see [Algorithms][1].
33235
+ #
33236
+ # **Pipe mode**
33237
+ #
33238
+ # If an algorithm supports `Pipe` mode, Amazon SageMaker streams data
33239
+ # directly from Amazon S3 to the container.
33135
33240
  #
33136
- # If an algorithm supports the `File` input mode, Amazon SageMaker
33137
- # downloads the training data from S3 to the provisioned ML storage
33138
- # Volume, and mounts the directory to docker volume for training
33139
- # container. If an algorithm supports the `Pipe` input mode, Amazon
33140
- # SageMaker streams data directly from S3 to the container.
33241
+ # **File mode**
33242
+ #
33243
+ # If an algorithm supports `File` mode, SageMaker downloads the
33244
+ # training data from S3 to the provisioned ML storage volume, and
33245
+ # mounts the directory to the Docker volume for the training
33246
+ # container.
33247
+ #
33248
+ # You must provision the ML storage volume with sufficient capacity to
33249
+ # accommodate the data downloaded from S3. In addition to the training
33250
+ # data, the ML storage volume also stores the output model. The
33251
+ # algorithm container uses the ML storage volume to also store
33252
+ # intermediate information, if any.
33253
+ #
33254
+ # For distributed algorithms, training data is distributed uniformly.
33255
+ # Your training duration is predictable if the input data objects
33256
+ # sizes are approximately the same. SageMaker does not split the files
33257
+ # any further for model training. If the object sizes are skewed,
33258
+ # training won't be optimal as the data distribution is also skewed
33259
+ # when one host in a training cluster is overloaded, thus becoming a
33260
+ # bottleneck in training.
33261
+ #
33262
+ # **FastFile mode**
33263
+ #
33264
+ # If an algorithm supports `FastFile` mode, SageMaker streams data
33265
+ # directly from S3 to the container with no code changes, and provides
33266
+ # file system access to the data. Users can author their training
33267
+ # script to interact with these files as if they were stored on disk.
33268
+ #
33269
+ # `FastFile` mode works best when the data is read sequentially.
33270
+ # Augmented manifest files aren't supported. The startup time is
33271
+ # lower when there are fewer files in the S3 bucket provided.
33141
33272
  #
33142
33273
  #
33143
33274
  #
@@ -33331,7 +33462,7 @@ module Aws::SageMaker
33331
33462
  # is_required: false,
33332
33463
  # supported_content_types: ["ContentType"], # required
33333
33464
  # supported_compression_types: ["None"], # accepts None, Gzip
33334
- # supported_input_modes: ["Pipe"], # required, accepts Pipe, File
33465
+ # supported_input_modes: ["Pipe"], # required, accepts Pipe, File, FastFile
33335
33466
  # },
33336
33467
  # ],
33337
33468
  # supported_tuning_job_objective_metrics: [
@@ -34110,8 +34241,7 @@ module Aws::SageMaker
34110
34241
  # @return [Time]
34111
34242
  #
34112
34243
  # @!attribute [rw] created_by
34113
- # Information about the user who created or modified an experiment,
34114
- # trial, or trial component.
34244
+ # Who created the trial.
34115
34245
  # @return [Types::UserContext]
34116
34246
  #
34117
34247
  # @!attribute [rw] last_modified_time
@@ -34120,7 +34250,7 @@ module Aws::SageMaker
34120
34250
  #
34121
34251
  # @!attribute [rw] last_modified_by
34122
34252
  # Information about the user who created or modified an experiment,
34123
- # trial, or trial component.
34253
+ # trial, trial component, or project.
34124
34254
  # @return [Types::UserContext]
34125
34255
  #
34126
34256
  # @!attribute [rw] metadata_properties
@@ -34194,8 +34324,7 @@ module Aws::SageMaker
34194
34324
  # @return [Time]
34195
34325
  #
34196
34326
  # @!attribute [rw] created_by
34197
- # Information about the user who created or modified an experiment,
34198
- # trial, or trial component.
34327
+ # Who created the trial component.
34199
34328
  # @return [Types::UserContext]
34200
34329
  #
34201
34330
  # @!attribute [rw] last_modified_time
@@ -34204,7 +34333,7 @@ module Aws::SageMaker
34204
34333
  #
34205
34334
  # @!attribute [rw] last_modified_by
34206
34335
  # Information about the user who created or modified an experiment,
34207
- # trial, or trial component.
34336
+ # trial, trial component, or project.
34208
34337
  # @return [Types::UserContext]
34209
34338
  #
34210
34339
  # @!attribute [rw] parameters
@@ -34415,7 +34544,7 @@ module Aws::SageMaker
34415
34544
  #
34416
34545
  # @!attribute [rw] created_by
34417
34546
  # Information about the user who created or modified an experiment,
34418
- # trial, or trial component.
34547
+ # trial, trial component, or project.
34419
34548
  # @return [Types::UserContext]
34420
34549
  #
34421
34550
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/TrialComponentSimpleSummary AWS API Documentation
@@ -34555,7 +34684,7 @@ module Aws::SageMaker
34555
34684
  # @return [Time]
34556
34685
  #
34557
34686
  # @!attribute [rw] created_by
34558
- # Who created the component.
34687
+ # Who created the trial component.
34559
34688
  # @return [Types::UserContext]
34560
34689
  #
34561
34690
  # @!attribute [rw] last_modified_time
@@ -36442,7 +36571,7 @@ module Aws::SageMaker
36442
36571
  end
36443
36572
 
36444
36573
  # Information about the user who created or modified an experiment,
36445
- # trial, or trial component.
36574
+ # trial, trial component, or project.
36446
36575
  #
36447
36576
  # @!attribute [rw] user_profile_arn
36448
36577
  # The Amazon Resource Name (ARN) of the user's profile.