Skip to content

Add API doc for Airflow #543

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 2 commits into from
Dec 10, 2018
Merged

Add API doc for Airflow #543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b61084f
Add API doc for Airflow
yangaws Dec 10, 2018
f38f4d9
Address comments
yangaws Dec 10, 2018
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
1 change: 1 addition & 0 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ CHANGELOG
* feature: Local Mode: Add support for intermediate output to a local directory.
* bug-fix: Update PyYAML version to avoid conflicts with docker-compose
* doc-fix: Correct the numbered list in the table of contents
* doc-fix: Add Airflow API documentation

1.16.1.post1
============
Expand Down
13 changes: 11 additions & 2 deletions doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ Reinforcement Learning
A managed environment for Reinforcement Learning training and hosting on Amazon SageMaker

.. toctree::
:maxdepth: 2
:maxdepth: 2

sagemaker.rl
sagemaker.rl

SageMaker First-Party Algorithms
--------------------------------
Expand All @@ -62,3 +62,12 @@ Amazon provides implementations of some common machine learning algortithms opti
factorization_machines
lda
ntm

Workflows
---------
SageMaker APIs to export configurations for creating and managing Airflow workflows.

.. toctree::
:maxdepth: 2

sagemaker.workflow.airflow
42 changes: 42 additions & 0 deletions doc/sagemaker.workflow.airflow.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
Airflow
=======

training_config
---------------

.. autofunction:: sagemaker.workflow.airflow.training_config

tuning_config
-------------

.. autofunction:: sagemaker.workflow.airflow.tuning_config

model_config
------------

.. autofunction:: sagemaker.workflow.airflow.model_config

model_config_from_estimator
---------------------------

.. autofunction:: sagemaker.workflow.airflow.model_config_from_estimator

transform_config
----------------

.. autofunction:: sagemaker.workflow.airflow.transform_config

transform_config_from_estimator
-------------------------------

.. autofunction:: sagemaker.workflow.airflow.transform_config_from_estimator

deploy_config
-------------

.. autofunction:: sagemaker.workflow.airflow.deploy_config

deploy_config_from_estimator
----------------

.. autofunction:: sagemaker.workflow.airflow.deploy_config_from_estimator