:orphan:

Papermill
=========

It is possible to run a Jupyter notebook as a Flyte task using `papermill <https://github.com/nteract/papermill>`_.
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:

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
------------

To use the flytekit papermill plugin simply run the following:

.. prompt:: bash

   pip install flytekitplugins-papermill



.. raw:: html

    <div class="sphx-glr-thumbnails">


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Jupyter Notebook Tasks">

.. only:: html

  .. image:: /auto/integrations/flytekit_plugins/papermilltasks/images/thumb/sphx_glr_simple_thumb.png
    :alt: Jupyter Notebook Tasks

  :ref:`sphx_glr_auto_integrations_flytekit_plugins_papermilltasks_simple.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Jupyter Notebook Tasks</div>
    </div>


.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto/integrations/flytekit_plugins/papermilltasks/simple


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download all examples in Python source code: papermilltasks_python.zip </auto/integrations/flytekit_plugins/papermilltasks/papermilltasks_python.zip>`

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download all examples in Jupyter notebooks: papermilltasks_jupyter.zip </auto/integrations/flytekit_plugins/papermilltasks/papermilltasks_jupyter.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_