[Pipelines] Add doc on disabling default caching flag and env var #3880
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DharmitD
force-pushed
the
caching-docs
branch
from
a08d620
to
c20f893
Compare
hbelmiro
reviewed
Sep 26, 2024
Comment on lines
67
to
69
| Environment Variable `KFP_DISABLE_EXECUTION_CACHING_BY_DEFAULT`. | ||
|
|
||
| You can also set the default caching behavior by using the 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.\ |
There was a problem hiding this comment.
This Environment Variable KFP_DISABLE_EXECUTION_CACHING_BY_DEFAULT. looks misplaced.
How about the following?
Suggested change
| Environment Variable `KFP_DISABLE_EXECUTION_CACHING_BY_DEFAULT`. | |
| You can also set the default caching behavior by using the 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.\ | |
| 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.\ |
There was a problem hiding this comment.
Yes, I'd taken it out but didn't get pushed by mistake. Updated now, thanks!
| ``` | ||
| 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. |
There was a problem hiding this comment.
Suggested change
| 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. | |
| 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. |
There was a problem hiding this comment.
Done, updated to add ``.
Signed-off-by: ddalvi <[email protected]>
DharmitD
force-pushed
the
caching-docs
branch
from
c20f893
to
a90bd6f
Compare
DharmitD
changed the title
DharmitD
changed the title
|
Looks good to me! |
|
/lgtm |
hbelmiro
approved these changes
Sep 26, 2024
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: hbelmiro The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
DharmitD
added a commit
to DharmitD/website
that referenced
this pull request
Oct 9, 2024
… var (kubeflow#3880)" This reverts commit 7b7c037.
DharmitD
added a commit
to DharmitD/website
that referenced
this pull request
Oct 9, 2024
… var (kubeflow#3880)" This reverts commit 7b7c037. Signed-off-by: ddalvi <[email protected]>
DharmitD
added a commit
to DharmitD/website
that referenced
this pull request
Oct 9, 2024
… var (kubeflow#3880)" This reverts commit 7b7c037. Signed-off-by: ddalvi <[email protected]>
google-oss-prow bot
pushed a commit
that referenced
this pull request
Oct 14, 2024
) * Revert "[Pipelines] Specify KFP SDK version where new caching flag will be available (#3881)" This reverts commit 090f09b. Signed-off-by: ddalvi <[email protected]> * Revert "[Pipelines] Add doc on disabling default caching flag and env var (#3880)" This reverts commit 7b7c037. Signed-off-by: ddalvi <[email protected]> * Fix enable_caching option's comment typo Signed-off-by: ddalvi <[email protected]> --------- Signed-off-by: ddalvi <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ref: kubeflow/pipelines#11222