Skip to content

Commit

Permalink
Revert "[Pipelines] Add doc on disabling default caching flag and env…
Browse files Browse the repository at this point in the history
… var (kubeflow#3880)"

This reverts commit 7b7c037.

Signed-off-by: ddalvi <[email protected]>
  • Loading branch information
DharmitD committed Oct 9, 2024
1 parent ddc4003 commit 539ab2b
Showing 1 changed file with 0 additions and 37 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -57,40 +57,3 @@ client.create_run_from_pipeline_func(
enable_caching=True, # overrides the above disableing of caching
)
```

The `--disable-execution-caching-by-default` flag disables caching for all pipeline tasks by default.

Example:
```
kfp dsl compile --py my_pipeline.py --output my_pipeline.yaml --disable-execution-caching-by-default
```

You can also set the default caching behavior by using the `KFP_DISABLE_EXECUTION_CACHING_BY_DEFAULT` environment variable. When set to true, 1, or other truthy values, it will disable execution caching by default for all pipelines. When set to false or when absent, the default of caching enabled remains.\
Example:
```
KFP_DISABLE_EXECUTION_CACHING_BY_DEFAULT=true \
kfp dsl compile --py my_pipeline.py --output my_pipeline.yaml
```
This environment variable also works for `Compiler().compile()`.

Given the following pipeline file:
```
@dsl.pipeline(name='my-pipeline')
def my_pipeline():
task_1 = create_dataset()
task_2 = create_dataset()
task_1.set_caching_options(False)
Compiler().compile(
pipeline_func=my_pipeline,
package_path='my_pipeline.yaml',
)
```
Executing this
```
KFP_DISABLE_EXECUTION_CACHING_BY_DEFAULT=true \
python my_pipeline.py
```
will result in `task_2` having caching disabled.

**NOTE**: Since Python initializes configurations during the import process, setting the `KFP_DISABLE_EXECUTION_CACHING_BY_DEFAULT` environment variable after importing pipeline components will not affect the caching behavior. Therefore, always set it before importing any Kubeflow Pipelines components.

0 comments on commit 539ab2b

Please sign in to comment.