Skip to content

Commit 560de69

Browse files
IvyBazanDan Choi
IvyBazan
authored and
Dan Choi
committed
documentation: add pipeline rst docs and address grammatical issues (#499)
1 parent 0ab3af9 commit 560de69

File tree

12 files changed

+201
-207
lines changed

12 files changed

+201
-207
lines changed

‎doc/workflows/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ The SageMaker Python SDK supports managed training and inference for a variety o
99

1010
airflow/index
1111
step_functions/index
12-
.. pipelines/index
12+
pipelines/index

‎doc/workflows/pipelines/index.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
################
2+
Amazon Pipelines
3+
################
4+
5+
SageMaker APIs for creating and managing Amazon Pipelines.
6+
7+
.. toctree::
8+
:maxdepth: 2
9+
10+
sagemaker.workflow.pipelines

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

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
Pipelines
2+
=========
3+
4+
ConditionStep
5+
-------------
6+
7+
.. autoclass:: sagemaker.workflow.condition_step.ConditionStep
8+
9+
.. autoclass:: sagemaker.workflow.condition_step.JsonGet
10+
11+
Conditions
12+
----------
13+
14+
.. autoclass:: sagemaker.workflow.conditions.ConditionTypeEnum
15+
16+
.. autoclass:: sagemaker.workflow.conditions.Condition
17+
18+
.. autoclass:: sagemaker.workflow.conditions.ConditionComparison
19+
20+
.. autoclass:: sagemaker.workflow.conditions.ConditionEquals
21+
22+
.. autoclass:: sagemaker.workflow.conditions.ConditionGreaterThan
23+
24+
.. autoclass:: sagemaker.workflow.conditions.ConditionGreaterThanOrEqualTo
25+
26+
.. autoclass:: sagemaker.workflow.conditions.ConditionLessThan
27+
28+
.. autoclass:: sagemaker.workflow.conditions.ConditionLessThanOrEqualTo
29+
30+
.. autoclass:: sagemaker.workflow.conditions.ConditionIn
31+
32+
.. autoclass:: sagemaker.workflow.conditions.ConditionNot
33+
34+
.. autoclass:: sagemaker.workflow.conditions.ConditionOr
35+
36+
.. autofunction:: sagemaker.workflow.conditions.primitive_or_expr
37+
38+
Entities
39+
--------
40+
41+
.. autoclass:: sagemaker.workflow.entities.Entity
42+
43+
.. autoclass:: sagemaker.workflow.entities.DefaultEnumMeta
44+
45+
.. autoclass:: sagemaker.workflow.entities.Expression
46+
47+
Execution_variables
48+
-------------------
49+
50+
.. autoclass:: sagemaker.workflow.execution_variables.ExecutionVariable
51+
52+
.. autoclass:: sagemaker.workflow.execution_variables.ExecutionVariables
53+
54+
Parameters
55+
----------
56+
57+
.. autoclass:: sagemaker.workflow.parameters.ParameterTypeEnum
58+
59+
.. autoclass:: sagemaker.workflow.parameters.Parameter
60+
61+
.. autoclass:: sagemaker.workflow.parameters.ParameterString
62+
63+
.. autoclass:: sagemaker.workflow.parameters.ParameterInteger
64+
65+
.. autoclass:: sagemaker.workflow.parameters.ParameterFloat
66+
67+
Pipeline
68+
--------
69+
70+
.. autoclass:: sagemaker.workflow.pipeline.Pipeline
71+
72+
.. autofunction:: sagemaker.workflow.pipeline.format_start_parameters
73+
74+
.. autofunction:: sagemaker.workflow.pipeline.interpolate
75+
76+
.. autofunction:: sagemaker.workflow.pipeline.update_args
77+
78+
Properties
79+
----------
80+
81+
.. autoclass:: sagemaker.workflow.properties.PropertiesMeta
82+
83+
.. autoclass:: sagemaker.workflow.properties.Properties
84+
85+
.. autoclass:: sagemaker.workflow.properties.PropertiesList
86+
87+
.. autoclass:: sagemaker.workflow.properties.PropertyFile
88+
89+
Step Collections
90+
----------------
91+
92+
.. autoclass:: sagemaker.workflow.step_collections.StepCollection
93+
94+
.. autoclass:: sagemaker.workflow.step_collections.RegisterModel
95+
96+
.. autoclass:: sagemaker.workflow.step_collections.EstimatorTransformer
97+
98+
Steps
99+
-----
100+
101+
.. autoclass:: sagemaker.workflow.steps.StepTypeEnum
102+
103+
.. autoclass:: sagemaker.workflow.steps.Step
104+
105+
.. autoclass:: sagemaker.workflow.steps.TrainingStep
106+
107+
.. autoclass:: sagemaker.workflow.steps.CreateModelStep
108+
109+
.. autoclass:: sagemaker.workflow.steps.TransformStep
110+
111+
.. autoclass:: sagemaker.workflow.steps.ProcessingStep
112+
113+
.. autoclass:: sagemaker.workflow.steps.FailStep
114+
115+
Utilities
116+
---------
117+
118+
.. autofunction:: sagemaker.workflow.utilities.list_to_request

‎src/sagemaker/workflow/condition_step.py

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,7 @@
3535

3636

3737
class ConditionStep(Step):
38-
"""Conditional step for pipelines to support conditional branching in the execution of steps.
39-
40-
Attributes:
41-
name (str): The name of the condition step.
42-
step_type (StepTypeEnum): The type of the step with value `StepTypeEnum.CONDITION`.
43-
conditions (List[Condition]): A list of `sagemaker.workflow.conditions.Condition` instances.
44-
if_steps (List[Union[Step, StepCollection]]): A list of `sagemaker.workflow.steps.Step`
45-
and `sagemaker.workflow.step_collections.StepCollection` instances.
46-
else_steps (List[Union[Step, StepCollection]]): A list of `sagemaker.workflow.steps.Step`
47-
and `sagemaker.workflow.step_collections.StepCollection` instances.
48-
"""
38+
"""Conditional step for pipelines to support conditional branching in the execution of steps."""
4939

5040
def __init__(
5141
self,
@@ -54,22 +44,21 @@ def __init__(
5444
if_steps: List[Union[Step, StepCollection]] = None,
5545
else_steps: List[Union[Step, StepCollection]] = None,
5646
):
57-
"""Constructs a ConditionStep for conditional execution branching.
47+
"""Construct a ConditionStep for pipelines to support conditional branching.
5848
5949
If all of the conditions in the condition list evaluate to True, the `if_steps` are
6050
marked as ready for execution. Otherwise, the `else_steps` are marked as ready for
6151
execution.
6252
6353
Args:
64-
name (str): The name of the training step.
6554
conditions (List[Condition]): A list of `sagemaker.workflow.conditions.Condition`
6655
instances.
6756
if_steps (List[Union[Step, StepCollection]]): A list of `sagemaker.workflow.steps.Step`
6857
and `sagemaker.workflow.step_collections.StepCollection` instances that are
6958
marked as ready for execution if the list of conditions evaluates to True.
7059
else_steps (List[Union[Step, StepCollection]]): A list of `sagemaker.workflow.steps.Step`
7160
and `sagemaker.workflow.step_collections.StepCollection` instances that are
72-
marked as ready for execution if the list of conditions evaluates to True.
61+
marked as ready for execution if the list of conditions evaluates to False.
7362
"""
7463
super(ConditionStep, self).__init__(name, StepTypeEnum.CONDITION)
7564
self.conditions = conditions or []
@@ -98,7 +87,7 @@ def properties(self):
9887

9988
@attr.s
10089
class JsonGet(Expression):
101-
"""A function to get JSON properties from PropertyFiles.
90+
"""Get JSON properties from PropertyFiles.
10291
10392
Attributes:
10493
step (Step): The step from which to get the property file.

0 commit comments

Comments
 (0)