Skip to content

documentation: heterogeneous cluster api doc fix #3248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 26, 2022
Merged

documentation: heterogeneous cluster api doc fix #3248

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
91ccda4
documentation: heterogeneous cluster api doc fix
mchoi8739 Jul 18, 2022
66959bf
Trigger Build
mchoi8739 Jul 21, 2022
a35f76c
Trigger Build
mchoi8739 Jul 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions src/sagemaker/inputs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,16 @@ def __init__(
AugmentedManifestFile formats are described at `S3DataSource
<https://docs.aws.amazon.com/sagemaker/latest/dg/API_S3DataSource.html>`_
in the `Amazon SageMaker API reference`.
instance_groups (list[str]): Optional. A list of ``instance_group_name``\ s
of a heterogeneous cluster that's configured using the
instance_groups (list[str]): Optional. A list of instance group names in string format
that you specified while configuring a heterogeneous cluster using the
:class:`sagemaker.instance_group.InstanceGroup`.
S3 data will be sent to all instance groups in the specified list.
For instructions on how to use InstanceGroup objects
to configure a heterogeneous cluster
through the SageMaker generic and framework estimator classes, see
`Train Using a Heterogeneous Cluster
<https://docs.aws.amazon.com/sagemaker/latest/dg/train-heterogeneous-cluster.html>`_
in the *Amazon SageMaker developer guide*.
(default: None)
input_mode (str): Optional override for this channel's input mode (default: None).
By default, channels will use the input mode defined on
Expand Down