Skip to content

Commit 4b2b6f7

Browse files
author
Shegufta Ahsan
committed
updating the documentations
1 parent 16f4c1d commit 4b2b6f7

File tree

2 files changed

+22
-13
lines changed

2 files changed

+22
-13
lines changed

doc/workflows/pipelines/sagemaker.workflow.pipelines.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,4 +169,8 @@ Steps
169169

170170
.. autoclass:: sagemaker.workflow.fail_step.FailStep
171171

172+
.. autoclass:: sagemaker.workflow.emr_step.EMRStepConfig
173+
174+
.. autoclass:: sagemaker.workflow.emr_step.EMRStep
175+
172176
.. autoclass:: sagemaker.workflow.automl_step.AutoMLStep

src/sagemaker/workflow/emr_step.py

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ def __init__(
3333
):
3434
"""Create a definition for input data used by an EMR cluster(job flow) step.
3535
36-
See AWS documentation on the ``StepConfig`` API for more details on the parameters.
36+
See AWS documentation for more information about the `StepConfig
37+
<https://docs.aws.amazon.com/emr/latest/APIReference/API_StepConfig.html>`_ API parameters.
3738
3839
Args:
3940
args(List[str]):
@@ -155,7 +156,7 @@ def __init__(
155156
cache_config: CacheConfig = None,
156157
cluster_config: Dict[str, Any] = None,
157158
):
158-
"""Constructs an EMRStep.
159+
"""Constructs an `EMRStep`.
159160
160161
Args:
161162
name(str): The name of the EMR step.
@@ -168,19 +169,23 @@ def __init__(
168169
depends on.
169170
cache_config(CacheConfig): A `sagemaker.workflow.steps.CacheConfig` instance.
170171
cluster_config(Dict[str, Any]): The recipe of the
171-
EMR cluster, passed as a dictionary. The elements are defined in the request syntax
172-
for RunJobFlow. However, the following elements are not recognized as part of the
173-
cluster configuration and you should not include them in the dictionary:
174-
1. cluster_config[Name]
175-
2. cluster_config[Steps]
176-
3. cluster_config[AutoTerminationPolicy]
177-
4. cluster_config[Instances][KeepJobFlowAliveWhenNoSteps]
178-
5. cluster_config[Instances][TerminationProtected]
172+
EMR cluster, passed as a dictionary.
173+
The elements are defined in the request syntax for `RunJobFlow`.
174+
However, the following elements are not recognized as part of the cluster
175+
configuration and you should not include them in the dictionary:
176+
177+
* ``cluster_config[Name]``
178+
* ``cluster_config[Steps]``
179+
* ``cluster_config[AutoTerminationPolicy]``
180+
* ``cluster_config[Instances][KeepJobFlowAliveWhenNoSteps]``
181+
* ``cluster_config[Instances][TerminationProtected]``
182+
179183
For more information about the fields you can include in your cluster
180184
configuration, see
181-
https://docs.aws.amazon.com/emr/latest/APIReference/API_RunJobFlow.html
182-
Note that if you want to use cluster_config,
183-
then you have to set cluster_id as None.
185+
https://docs.aws.amazon.com/emr/latest/APIReference/API_RunJobFlow.html.
186+
Note that if you want to use ``cluster_config``, then you have to set
187+
``cluster_id`` as None.
188+
184189
"""
185190
super(EMRStep, self).__init__(name, display_name, description, StepTypeEnum.EMR, depends_on)
186191

0 commit comments

Comments
 (0)