New option in CLI to provide subcommands help when components given in a dict

mauvilsa commented 5 months ago

What does this PR do?

Implements https://github.com/Lightning-AI/litgpt/issues/996#issuecomment-1996201548

Before submitting

[x] Did you read the contributing guideline?
[x] Did you update the documentation? (readme and public docstrings)
[x] Did you write unit tests such that there is 100% coverage on related code? (required for bug fixes and new features)
[x] Did you verify that new and existing tests pass locally?
[x] Did you make sure that all changes preserve backward compatibility?
[x] Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

codecov[bot] commented 5 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (028131c) to head (a83cb6b).

:exclamation: Current head a83cb6b differs from pull request most recent head 2ab9994. Consider uploading reports for the commit 2ab9994 to get more accurate results

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #485 +/- ## =========================================== + Coverage 99.98% 100.00% +0.01% =========================================== Files 21 21 Lines 6017 6016 -1 =========================================== Hits 6016 6016 + Misses 1 0 -1 ``` | [Flag](https://app.codecov.io/gh/omni-us/jsonargparse/pull/485/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | Coverage Δ | | |---|---|---| | [py3.10](https://app.codecov.io/gh/omni-us/jsonargparse/pull/485/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `88.41% <100.00%> (+0.01%)` | :arrow_up: | | [py3.10_all](https://app.codecov.io/gh/omni-us/jsonargparse/pull/485/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `98.73% <100.00%> (+0.01%)` | :arrow_up: | | [py3.10_pydantic1](https://app.codecov.io/gh/omni-us/jsonargparse/pull/485/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `48.90% <0.00%> (-0.05%)` | :arrow_down: | | [py3.10_pydantic2](https://app.codecov.io/gh/omni-us/jsonargparse/pull/485/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `48.62% <0.00%> (-0.05%)` | :arrow_down: | | [py3.10_types](https://app.codecov.io/gh/omni-us/jsonargparse/pull/485/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `98.73% <100.00%> (+0.01%)` | :arrow_up: | | [py3.11](https://app.codecov.io/gh/omni-us/jsonargparse/pull/485/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `88.39% <100.00%> (+0.72%)` | :arrow_up: | | [py3.11_all](https://app.codecov.io/gh/omni-us/jsonargparse/pull/485/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `98.73% <100.00%> (+0.91%)` | :arrow_up: | | [py3.11_types](https://app.codecov.io/gh/omni-us/jsonargparse/pull/485/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `98.73% <100.00%> (+0.91%)` | :arrow_up: | | [py3.12](https://app.codecov.io/gh/omni-us/jsonargparse/pull/485/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `88.39% <100.00%> (+0.01%)` | :arrow_up: | | [py3.12_all](https://app.codecov.io/gh/omni-us/jsonargparse/pull/485/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `98.73% <100.00%> (+0.01%)` | :arrow_up: | | [py3.12_types](https://app.codecov.io/gh/omni-us/jsonargparse/pull/485/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `98.73% <100.00%> (+0.01%)` | :arrow_up: | | [py3.7](https://app.codecov.io/gh/omni-us/jsonargparse/pull/485/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `88.98% <100.00%> (+0.01%)` | :arrow_up: | | [py3.7_all](https://app.codecov.io/gh/omni-us/jsonargparse/pull/485/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `99.49% <100.00%> (+0.01%)` | :arrow_up: | | [py3.7_types](https://app.codecov.io/gh/omni-us/jsonargparse/pull/485/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `99.48% <100.00%> (+0.01%)` | :arrow_up: | | [py3.8](https://app.codecov.io/gh/omni-us/jsonargparse/pull/485/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `89.12% <100.00%> (+0.01%)` | :arrow_up: | | [py3.8_all](https://app.codecov.io/gh/omni-us/jsonargparse/pull/485/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `99.51% <100.00%> (+0.01%)` | :arrow_up: | | [py3.8_types](https://app.codecov.io/gh/omni-us/jsonargparse/pull/485/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `99.50% <100.00%> (+0.01%)` | :arrow_up: | | [py3.9](https://app.codecov.io/gh/omni-us/jsonargparse/pull/485/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `88.97% <100.00%> (+0.01%)` | :arrow_up: | | [py3.9_all](https://app.codecov.io/gh/omni-us/jsonargparse/pull/485/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `99.38% <100.00%> (+0.01%)` | :arrow_up: | | [py3.9_types](https://app.codecov.io/gh/omni-us/jsonargparse/pull/485/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us) | `99.38% <100.00%> (+0.01%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=omni-us#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.