fix: Incorrect URI Prefix Stripping in MLFlowLogger #20365
Merged
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.
What does this PR do?
Addresses the issue described in issue 20279. Essentially, str.lstrip() is used incorrectly, causing the MLFlowLogger to log in the wrong location under certain conditions. This can be fixed by stripping the uri prefix with another function. As str.removeprefix() was only introduced with Python 3.9.0, this pull request uses a more general method to strip the string, which should be okay because the method is contained by the if statement.
Background
The save_dir property in the MLFlowLogger class currently uses str.lstrip() to remove the LOCAL_FILE_URI_PREFIX ("file:") from the tracking URI. This method does not strip the prefix, but all characters that match those in the prefix ("f", "i", "l", "e", ":"). Thus, setting save_dir="logs" would be incorrectly modified to "ogs", leading to the creation of an "ogs" folder where logging subsequently occurs.
Minimal Example
Fixes #20279
Before submitting
PR review
Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:
Reviewer checklist
📚 Documentation preview 📚: https://pytorch-lightning--20365.org.readthedocs.build/en/20365/