Skip to content

Commit

Permalink
fix papermill example formatting (flyteorg#464)
Browse files Browse the repository at this point in the history
* fix papermill example formatting

Signed-off-by: Niels Bantilan <[email protected]>

* Update README.rst

* Update README.rst

* Update README.rst

Signed-off-by: Niels Bantilan <[email protected]>
  • Loading branch information
cosmicBboy authored Oct 25, 2021
1 parent ebe92e8 commit 0d7ef59
Showing 1 changed file with 8 additions and 11 deletions.
19 changes: 8 additions & 11 deletions cookbook/integrations/flytekit_plugins/papermilltasks/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,14 @@ It is possible to run a Jupyter notebook as a Flyte task using `papermill <https
Papermill executes the notebook as a whole, so before using this plugin, it is essential to construct your notebook as
recommended by papermill. When using this plugin, there are a few important things to keep in mind:

Salient points
--------------

#. This plugin can be used for any task - type.
- It can be python code, which can be a tensorflow model, a data transformation, etc - but things that run in a
container and you would typically write in a ``@task``.
- It can be a :py:func:`~flytekit.dynamic` workflow.
- It can be a any other plugin like ``spark``, ``sagemaker`` etc, **ensure that the plugin is installed as well**
#. Flytekit will execute the notebook and capture the output notebook as an *.ipynb* file and an HTML rendered notebook as well
#. Flytekit will pass the inputs into the notebook as long as you have the first cell annotated as ``parameters`` and inputs are specified
#. Flytekit will read the outputs from the notebook, as long as you use annotate the notebook with ``outputs`` and outputs are specified
1. This plugin can be used for any task - type.
- It can be python code, which can be a tensorflow model, a data transformation, etc - but things that run in a container
and you would typically write in a ``@task``.
- It can be a :py:func:`~flytekit.dynamic` workflow.
- It can be a any other plugin like ``spark``, ``sagemaker`` etc, **ensure that the plugin is installed as well**
2. Flytekit will execute the notebook and capture the output notebook as an *.ipynb* file and an HTML rendered notebook as well
3. Flytekit will pass the inputs into the notebook as long as you have the first cell annotated as ``parameters`` and inputs are specified
4. Flytekit will read the outputs from the notebook, as long as you use annotate the notebook with ``outputs`` and outputs are specified


Installation
Expand Down

0 comments on commit 0d7ef59

Please sign in to comment.