Skip to content

Commit 011539a

Browse files
authored
documentation: heterogeneous cluster api doc fix (#3248)
1 parent 9c72d7a commit 011539a

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

src/sagemaker/inputs.py

+8-2
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,16 @@ def __init__(
6767
AugmentedManifestFile formats are described at `S3DataSource
6868
<https://docs.aws.amazon.com/sagemaker/latest/dg/API_S3DataSource.html>`_
6969
in the `Amazon SageMaker API reference`.
70-
instance_groups (list[str]): Optional. A list of ``instance_group_name``\ s
71-
of a heterogeneous cluster that's configured using the
70+
instance_groups (list[str]): Optional. A list of instance group names in string format
71+
that you specified while configuring a heterogeneous cluster using the
7272
:class:`sagemaker.instance_group.InstanceGroup`.
7373
S3 data will be sent to all instance groups in the specified list.
74+
For instructions on how to use InstanceGroup objects
75+
to configure a heterogeneous cluster
76+
through the SageMaker generic and framework estimator classes, see
77+
`Train Using a Heterogeneous Cluster
78+
<https://docs.aws.amazon.com/sagemaker/latest/dg/train-heterogeneous-cluster.html>`_
79+
in the *Amazon SageMaker developer guide*.
7480
(default: None)
7581
input_mode (str): Optional override for this channel's input mode (default: None).
7682
By default, channels will use the input mode defined on

0 commit comments

Comments
 (0)