Skip to content

Commit 6555f09

Browse files
yangawsnadiaya
authored andcommitted
Add API doc for Airflow (#543)
1 parent bffdbff commit 6555f09

File tree

3 files changed

+54
-2
lines changed

3 files changed

+54
-2
lines changed

CHANGELOG.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ CHANGELOG
1414
* feature: Local Mode: Add support for intermediate output to a local directory.
1515
* bug-fix: Update PyYAML version to avoid conflicts with docker-compose
1616
* doc-fix: Correct the numbered list in the table of contents
17+
* doc-fix: Add Airflow API documentation
1718

1819
1.16.1.post1
1920
============

doc/index.rst

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ Reinforcement Learning
4444
A managed environment for Reinforcement Learning training and hosting on Amazon SageMaker
4545

4646
.. toctree::
47-
:maxdepth: 2
47+
:maxdepth: 2
4848

49-
sagemaker.rl
49+
sagemaker.rl
5050

5151
SageMaker First-Party Algorithms
5252
--------------------------------
@@ -62,3 +62,12 @@ Amazon provides implementations of some common machine learning algortithms opti
6262
factorization_machines
6363
lda
6464
ntm
65+
66+
Workflows
67+
---------
68+
SageMaker APIs to export configurations for creating and managing Airflow workflows.
69+
70+
.. toctree::
71+
:maxdepth: 2
72+
73+
sagemaker.workflow.airflow

doc/sagemaker.workflow.airflow.rst

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
Airflow
2+
=======
3+
4+
training_config
5+
---------------
6+
7+
.. autofunction:: sagemaker.workflow.airflow.training_config
8+
9+
tuning_config
10+
-------------
11+
12+
.. autofunction:: sagemaker.workflow.airflow.tuning_config
13+
14+
model_config
15+
------------
16+
17+
.. autofunction:: sagemaker.workflow.airflow.model_config
18+
19+
model_config_from_estimator
20+
---------------------------
21+
22+
.. autofunction:: sagemaker.workflow.airflow.model_config_from_estimator
23+
24+
transform_config
25+
----------------
26+
27+
.. autofunction:: sagemaker.workflow.airflow.transform_config
28+
29+
transform_config_from_estimator
30+
-------------------------------
31+
32+
.. autofunction:: sagemaker.workflow.airflow.transform_config_from_estimator
33+
34+
deploy_config
35+
-------------
36+
37+
.. autofunction:: sagemaker.workflow.airflow.deploy_config
38+
39+
deploy_config_from_estimator
40+
----------------
41+
42+
.. autofunction:: sagemaker.workflow.airflow.deploy_config_from_estimator

0 commit comments

Comments
 (0)