:orphan:

.. _basic:

Basics
------
In this section, you'll learn how to use the basic building blocks of Flyte using ``flytekit``.
``flytekit`` is a python SDK for developing flyte workflows and task and can be used generally, whenever stateful
computation is desirable. ``flytekit``-developed workflows and tasks are completely runnable locally, unless they need
some advanced backend functionality like starting a distributed spark cluster.

In this section we'll take a look at how to write flyte tasks, compose them together to form a workflow,
and then read, manipulate and cache data.



.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Hello World">

.. only:: html

  .. image:: /auto/core/flyte_basics/images/thumb/sphx_glr_hello_world_thumb.png
    :alt: Hello World

  :ref:`sphx_glr_auto_core_flyte_basics_hello_world.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Hello World</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Task is a fundamental building block and an extension point of Flyte, which encapsulates the us...">

.. only:: html

  .. image:: /auto/core/flyte_basics/images/thumb/sphx_glr_task_thumb.png
    :alt: Tasks

  :ref:`sphx_glr_auto_core_flyte_basics_task.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Once you have a handle on basics_of_tasks, we can dive into Flyte workflows. Together, Flyte ta...">

.. only:: html

  .. image:: /auto/core/flyte_basics/images/thumb/sphx_glr_basic_workflow_thumb.png
    :alt: Workflows

  :ref:`sphx_glr_auto_core_flyte_basics_basic_workflow.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Workflows</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Workflows are typically created and specified by decorating a function with the @workflow decor...">

.. only:: html

  .. image:: /auto/core/flyte_basics/images/thumb/sphx_glr_imperative_wf_style_thumb.png
    :alt: Imperative Workflows

  :ref:`sphx_glr_auto_core_flyte_basics_imperative_wf_style.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Imperative Workflows</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Documented code helps enhance the readability of the code. Flyte supports docstrings to documen...">

.. only:: html

  .. image:: /auto/core/flyte_basics/images/thumb/sphx_glr_documented_workflow_thumb.png
    :alt: Add Docstrings to Workflows

  :ref:`sphx_glr_auto_core_flyte_basics_documented_workflow.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Add Docstrings to Workflows</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Launch plans bind a partial or complete list of inputs necessary to launch a workflow, along wi...">

.. only:: html

  .. image:: /auto/core/flyte_basics/images/thumb/sphx_glr_lp_thumb.png
    :alt: Launch Plans

  :ref:`sphx_glr_auto_core_flyte_basics_lp.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Launch Plans</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Deck enables users to get customizable and default visibility into their tasks.">

.. only:: html

  .. image:: /auto/core/flyte_basics/images/thumb/sphx_glr_deck_thumb.png
    :alt: Flyte Decks

  :ref:`sphx_glr_auto_core_flyte_basics_deck.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Flyte Decks</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Flyte provides the ability to cache the output of task executions to make the subsequent execut...">

.. only:: html

  .. image:: /auto/core/flyte_basics/images/thumb/sphx_glr_task_cache_thumb.png
    :alt: Caching

  :ref:`sphx_glr_auto_core_flyte_basics_task_cache.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Caching</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="To run bash scripts from within Flyte, ShellTask can be used. In this example, let&#x27;s define thr...">

.. only:: html

  .. image:: /auto/core/flyte_basics/images/thumb/sphx_glr_shell_task_thumb.png
    :alt: Run Bash Scripts Using ShellTask

  :ref:`sphx_glr_auto_core_flyte_basics_shell_task.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Run Bash Scripts Using ShellTask</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A :py:func:`flytekit.reference_task` references the Flyte tasks that have already been defined,...">

.. only:: html

  .. image:: /auto/core/flyte_basics/images/thumb/sphx_glr_reference_task_thumb.png
    :alt: Reference Task

  :ref:`sphx_glr_auto_core_flyte_basics_reference_task.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Reference Task</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Files are one of the most fundamental entities that users of Python work with, and they are ful...">

.. only:: html

  .. image:: /auto/core/flyte_basics/images/thumb/sphx_glr_files_thumb.png
    :alt: Working With Files

  :ref:`sphx_glr_auto_core_flyte_basics_files.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Working With Files</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In addition to files, folders are another fundamental operating system primitive users often wo...">

.. only:: html

  .. image:: /auto/core/flyte_basics/images/thumb/sphx_glr_folders_thumb.png
    :alt: Working With Folders

  :ref:`sphx_glr_auto_core_flyte_basics_folders.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Working With Folders</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="By default, Flyte names the outputs of a task or workflow using a standardized convention. All ...">

.. only:: html

  .. image:: /auto/core/flyte_basics/images/thumb/sphx_glr_named_outputs_thumb.png
    :alt: Named Outputs

  :ref:`sphx_glr_auto_core_flyte_basics_named_outputs.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Named Outputs</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="A simple way of modifying the behavior of tasks is by using decorators to wrap your task functi...">

.. only:: html

  .. image:: /auto/core/flyte_basics/images/thumb/sphx_glr_decorating_tasks_thumb.png
    :alt: Decorating Tasks

  :ref:`sphx_glr_auto_core_flyte_basics_decorating_tasks.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="The behavior of workflows can be modified in a light-weight fashion by using the built-in :py:f...">

.. only:: html

  .. image:: /auto/core/flyte_basics/images/thumb/sphx_glr_decorating_workflows_thumb.png
    :alt: Decorating Workflows

  :ref:`sphx_glr_auto_core_flyte_basics_decorating_workflows.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Decorating Workflows</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Serializing means only executing a single instance of a unique cacheable task (determined by th...">

.. only:: html

  .. image:: /auto/core/flyte_basics/images/thumb/sphx_glr_task_cache_serialize_thumb.png
    :alt: Cache Serializing

  :ref:`sphx_glr_auto_core_flyte_basics_task_cache_serialize.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Cache Serializing</div>
    </div>


.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto/core/flyte_basics/hello_world
   /auto/core/flyte_basics/task
   /auto/core/flyte_basics/basic_workflow
   /auto/core/flyte_basics/imperative_wf_style
   /auto/core/flyte_basics/documented_workflow
   /auto/core/flyte_basics/lp
   /auto/core/flyte_basics/deck
   /auto/core/flyte_basics/task_cache
   /auto/core/flyte_basics/shell_task
   /auto/core/flyte_basics/reference_task
   /auto/core/flyte_basics/files
   /auto/core/flyte_basics/folders
   /auto/core/flyte_basics/named_outputs
   /auto/core/flyte_basics/decorating_tasks
   /auto/core/flyte_basics/decorating_workflows
   /auto/core/flyte_basics/task_cache_serialize


.. 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: flyte_basics_python.zip </auto/core/flyte_basics/flyte_basics_python.zip>`

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

      :download:`Download all examples in Jupyter notebooks: flyte_basics_jupyter.zip </auto/core/flyte_basics/flyte_basics_jupyter.zip>`


.. only:: html

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

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