Update Checkpointing Docs to include details on initializing model with other hyperparameters #17767
+3
−1
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
…el with other hyperparameters Currently, docs do not include information that positional arguments will not be forwarded to the model. All examples include only keyword arguments. This bug causes many wasted hours of debugging every time.
shubhamkulkarni01
requested review from
edenlightning,
lantiga,
Borda and
awaelchli
as code owners
shubhamkulkarni01
changed the title
awaelchli
reviewed
Jun 8, 2023
| @@ -108,7 +108,7 @@ The LightningModule also has access to the Hyperparameters | |||
|
|
|||
| Initialize with other parameters | |||
| ================================ | |||
| If you used the *self.save_hyperparameters()* method in the init of the LightningModule, you can initialize the model with different hyperparameters. | |||
| If you used the *self.save_hyperparameters()* method in the init of the LightningModule, you can initialize the model with different hyperparameters. Named arguments passed to ``load_from_checkpoint`` will be forwarded to the model's ``__init__`` function, with the exception of arguments named ``strict``, ``map_location``, and ``hparams_file``, which are consumed by ``load_from_checkpoint``. Positional arguments will **not** be forwarded to the model. | |||
There was a problem hiding this comment.
Overall looks like a good addition, thanks!. Two minor comments:
- The last sentence sounds a bit misleading. "will not be forwarded" sounds like we are silently not doing anything with them, but in fact it is just not supported and will raise an error. Forcing this best practice is to avoid collision and user-error.
- Maybe the comment could be added at the bottom of the section, since it is better to introduce the user with the concept and the code examples first before pointing out additional details of optional usage patterns.
What do you think?
awaelchli
added
docs
|
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs. If you need further help see our docs: https://lightning.ai/docs/pytorch/latest/generated/CONTRIBUTING.html#pull-request or ask the assistance of a core contributor here or on Discord. Thank you for your contributions. |
|
@shubhamkulkarni01 mind pls check the merge conflicts? |
|
| GitGuardian id | Secret | Commit | Filename | |
|---|---|---|---|---|
| - | Generic High Entropy Secret | 78fa3af | tests/tests_app/utilities/test_login.py | View secret |
| - | Base64 Basic Authentication | 78fa3af | tests/tests_app/utilities/test_login.py | View secret |
🛠 Guidelines to remediate hardcoded secrets
- Understand the implications of revoking this secret by investigating where it is used in your code.
- Replace and store your secret safely. Learn here the best practices.
- Revoke and rotate this secret.
- If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.
To avoid such incidents in the future consider
- following these best practices for managing and storing secrets including API keys and other credentials
- install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.
🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.
Our GitHub checks need improvements? Share your feedbacks!
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.
What does this PR do?
Currently, docs do not include information that positional arguments will not be forwarded to the model. All examples include only keyword arguments. This bug causes many wasted hours of debugging every time.
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