Skip to content

Commit e20359f

Browse files
committed
rephrase the note
1 parent 9612533 commit e20359f

File tree

1 file changed

+25
-15
lines changed

1 file changed

+25
-15
lines changed

src/sagemaker/estimator.py

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -182,16 +182,21 @@ def __init__(
182182
183183
.. note::
184184
185-
When using an ML instance with `NVMe SSD volumes
186-
<https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html#nvme-ssd-volumes>`_,
185+
When you use an ML instance with `NVMe SSD volumes
186+
<https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html#nvme-ssd-volumes>`_
187+
such as ``ml.p4d``, ``ml.g4dn``, and ``ml.g5``,
188+
do not include this parameter in the estimator configuration.
189+
If you use one of those ML instance types,
187190
SageMaker doesn't provision Amazon EBS General Purpose SSD
188-
(gp2) storage.
189-
Available storage is fixed to the NVMe-type instance's storage
191+
(gp2) storage nor take this parameter to adjust the NVMe instance storage.
192+
Available storage is fixed to the NVMe instance storage
190193
capacity. SageMaker configures storage paths for training
191194
datasets, checkpoints, model artifacts, and outputs to use the
192-
entire capacity of the instance storage. For example, ML
193-
instance families with the NVMe-type instance storage include
194-
``ml.p4d``, ``ml.g4dn``, and ``ml.g5``.
195+
entire capacity of the instance storage.
196+
197+
Note that if you include this parameter and specify a number that
198+
exceeds the size of the NVMe volume attached to the instance type,
199+
SageMaker returns an ``Invalid VolumeSizeInGB`` error.
195200
196201
To look up instance types and their instance storage types
197202
and volumes, see `Amazon EC2 Instance Types
@@ -2264,7 +2269,7 @@ def __init__(
22642269
instance_count (int): Number of Amazon EC2 instances to use
22652270
for training. Required if instance_groups is not set.
22662271
instance_type (str): Type of EC2 instance to use for training,
2267-
for example, 'ml.c4.xlarge'. Required if instance_groups is
2272+
for example, ``'ml.c4.xlarge'``. Required if instance_groups is
22682273
not set.
22692274
volume_size (int): Size in GB of the storage volume to use for
22702275
storing input and output data during training (default: 30).
@@ -2282,16 +2287,21 @@ def __init__(
22822287
22832288
.. note::
22842289
2285-
When using an ML instance with `NVMe SSD volumes
2286-
<https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html#nvme-ssd-volumes>`_,
2290+
When you use an ML instance with `NVMe SSD volumes
2291+
<https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html#nvme-ssd-volumes>`_
2292+
such as ``ml.p4d``, ``ml.g4dn``, and ``ml.g5``,
2293+
do not include this parameter in the estimator configuration.
2294+
If you use one of those ML instance types,
22872295
SageMaker doesn't provision Amazon EBS General Purpose SSD
2288-
(gp2) storage.
2289-
Available storage is fixed to the NVMe-type instance's storage
2296+
(gp2) storage nor take this parameter to adjust the NVMe instance storage.
2297+
Available storage is fixed to the NVMe instance storage
22902298
capacity. SageMaker configures storage paths for training
22912299
datasets, checkpoints, model artifacts, and outputs to use the
2292-
entire capacity of the instance storage. For example, ML
2293-
instance families with the NVMe-type instance storage include
2294-
``ml.p4d``, ``ml.g4dn``, and ``ml.g5``.
2300+
entire capacity of the instance storage.
2301+
2302+
Note that if you include this parameter and specify a number that
2303+
exceeds the size of the NVMe volume attached to the instance type,
2304+
SageMaker returns an ``Invalid VolumeSizeInGB`` error.
22952305
22962306
To look up instance types and their instance storage types
22972307
and volumes, see `Amazon EC2 Instance Types

0 commit comments

Comments
 (0)