Caching

Flyte provides the ability to cache the output of task executions to make the subsequent executions faster. A well-behaved Flyte task should generate deterministic output given the same inputs and task functionality.

Task caching is useful when a user knows that many executions with the same inputs may occur. For example, consider the following scenarios:

  • Running a task periodically on a schedule

  • Running the code multiple times when debugging workflows

  • Running the commonly shared tasks amongst different workflows, which receive the same inputs

Let’s see how task caching can be enabled.

For any flytekit.task() in Flyte, there is always one required import, which is:

from flytekit import task

Task caching is disabled by default to avoid unintended consequences of caching tasks with side effects. To enable caching and control its behavior, use the cache and cache_version parameters when constructing a task. cache is a switch to enable or disable the cache, and cache_version pertains to the version of the cache. cache_version field indicates that the task functionality has changed. Bumping the cache_version is akin to invalidating the cache. Flyte users can manually update this version and Flyte will cache the next execution instead of relying on the old cache.

@task(cache=True, cache_version="1.0")
def square(n: int) -> int:
    """
     Parameters:
        n (int): name of the parameter for the task will be derived from the name of the input variable.
                 The type will be automatically deduced to Types.Integer

    Return:
        int: The label for the output will be automatically assigned, and the type will be deduced from the annotation

    """
    return n * n

In the above example, calling square(n=2) twice (even if it’s across different executions or different workflows) will only execute the multiplication operation once. The next time, the output will be made available immediately – (captured from the previous execution with the same inputs).

If in a subsequent code update, we update the signature of the task to return the original number along with the result, it’ll automatically invalidate the cache (even though the cache version remains the same).

flytekit.task() @task(cache=True, cache_version=”1.0”) def square(n: int) -> (int, int):

Note

If the user changes the task interface in any way (such as adding, removing, or editing inputs/outputs), Flyte will treat that as a task functionality change. In the subsequent execution, Flyte will run the task and store the outputs as new cached values.

Tip

Invalidating the cache can be done in two ways – modify the cache_version or update the task signature.

How the Caching Works

A task execution is cached based on the Project, Domain, Cache Version, Task Signature, and Inputs associated with the execution of the task.

  • Project: A task run under one project cannot use the cached task execution from another project which would cause inadvertent results between project teams that could result in data corruption.

  • Domain: To separate test, staging, and production data, task executions are not shared across these environments.

  • Cache Version: When task functionality changes, you can change the cache_version of the task. Flyte will know not to use older cached task executions and create a new cache entry on the subsequent execution.

  • Task Signature: The cache is specific to the task signature associated with the execution. The signature constitutes the task name, input parameter names/types, and the output parameter name/type.

  • Task Input Values: A well-formed Flyte task always produces deterministic outputs. This means, given a set of input values, every execution should have identical outputs. When task execution is cached, the input values are part of the cache key.

Note

Task executions can be cached across different versions of the task because a change in SHA does not necessarily mean that it correlates to a change in task functionality.

Total running time of the script: ( 0 minutes 0.000 seconds)

Gallery generated by Sphinx-Gallery