Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add checkpoint artifact path prefix to MLflow logger #20538

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add checkpoint artifact path prefix to MLflow logger #20538

wants to merge 3 commits into from
+69 −2

Conversation

benglewis
Copy link

@benglewis benglewis commented Jan 8, 2025 •
edited
Loading

What does this PR do?

Introduces a new checkpoint_artifact_path_prefix argument to MLFlowLogger which customizes the prefix for the model artifacts.

Fixes #20540

Before submitting
  • Was this discussed/agreed via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

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
  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

Add a new checkpoint_artifact_path_prefix parameter to the MLflow logger.

  • Modify src/lightning/pytorch/loggers/mlflow.py to include the new parameter in the MLFlowLogger class constructor and use it in the after_save_checkpoint method.
  • Update the documentation in docs/source-pytorch/visualize/loggers.rst to include the new checkpoint_artifact_path_prefix parameter.
  • Add a new test in tests/tests_pytorch/loggers/test_mlflow.py to verify the functionality of the checkpoint_artifact_path_prefix parameter and ensure it is used in the artifact path.

For more details, open the Copilot Workspace session.

📚 Documentation preview 📚: https://pytorch-lightning--20538.org.readthedocs.build/en/20538/

@benglewis
Add checkpoint artifact path prefix to MLflow logger
2091de7 
Add a new `checkpoint_artifact_path_prefix` parameter to the MLflow logger.

* Modify `src/lightning/pytorch/loggers/mlflow.py` to include the new parameter in the `MLFlowLogger` class constructor and use it in the `after_save_checkpoint` method.
* Update the documentation in `docs/source-pytorch/visualize/loggers.rst` to include the new `checkpoint_artifact_path_prefix` parameter.
* Add a new test in `tests/tests_pytorch/loggers/test_mlflow.py` to verify the functionality of the `checkpoint_artifact_path_prefix` parameter and ensure it is used in the artifact path.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/Lightning-AI/pytorch-lightning?shareId=XXXX-XXXX-XXXX-XXXX).
@github-actions github-actions bot added docs Documentation related pl Generic label for PyTorch Lightning package labels Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lantiga lantiga Awaiting requested review from lantiga lantiga is a code owner

@Borda Borda Awaiting requested review from Borda Borda is a code owner

@tchaton tchaton Awaiting requested review from tchaton tchaton is a code owner

@justusschock justusschock Awaiting requested review from justusschock justusschock is a code owner

@ethanwharris ethanwharris Awaiting requested review from ethanwharris ethanwharris is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
docs Documentation related pl Generic label for PyTorch Lightning package
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add new checkpoint_artifact_path_prefix argument MLFlowLogger to customize artifact path for model checkpoints
1 participant
@benglewis