Skip to content

Allow a custom parser class when using LightningCLI #20596

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.

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

Merged
merged 4 commits into from
Mar 10, 2025

Conversation

mauvilsa
Copy link
Contributor

@mauvilsa mauvilsa commented Feb 19, 2025

What does this PR do?

Recently jsonargparse added new possibilities by customizing the argument parser class, for example:

However, currently LightningCLI doesn't allow changing the parser class to use. This pull request makes that possible.

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

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

@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Feb 19, 2025
Copy link

codecov bot commented Feb 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79%. Comparing base (a3314d4) to head (bbf8c73).
Report is 112 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master   #20596   +/-   ##
=======================================
  Coverage      79%      79%           
=======================================
  Files         264      264           
  Lines       23316    23317    +1     
=======================================
+ Hits        18326    18372   +46     
+ Misses       4990     4945   -45     

@mergify mergify bot removed the has conflicts label Mar 10, 2025
@Borda Borda merged commit 5073ac1 into Lightning-AI:master Mar 10, 2025
77 checks passed
@mauvilsa mauvilsa deleted the cli-custom-parser-class branch March 10, 2025 17:50
Borda pushed a commit that referenced this pull request Mar 12, 2025
* Allow a custom parser class when using LightningCLI
* Update changelog

(cherry picked from commit 5073ac1)
lexierule pushed a commit that referenced this pull request Mar 18, 2025
* Allow a custom parser class when using LightningCLI
* Update changelog

(cherry picked from commit 5073ac1)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pl Generic label for PyTorch Lightning package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants