docs(csv_logs): Clarify CSV and YAML logging distinction and improve examples #20951
Conversation
This file contains hidden or 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
…les and file structure
for more information, see https://pre-commit.ci
Borda
approved these changes
Jul 7, 2025
Borda
reviewed
Aug 8, 2025
SkafteNicki
reviewed
Aug 13, 2025
| self.hparams.update(params) | ||
| hparams_file = os.path.join(self.log_dir, self.NAME_HPARAMS_FILE) | ||
| save_hparams_to_yaml(hparams_file, self.hparams) | ||
|
|
||
|
|
||
| class CSVLogger(Logger, FabricCSVLogger): | ||
| r"""Log to local file system in yaml and CSV format. | ||
| r"""Log to local file system in CSV and YAML format. |
There was a problem hiding this comment.
could we add the same docstring to the fabric CSVLogger
https://github.com/Lightning-AI/pytorch-lightning/blob/master/src/lightning/fabric/loggers/csv_logs.py
just copy paste
| @@ -140,6 +194,21 @@ def save_dir(self) -> str: | |||
| @override | |||
| @rank_zero_only | |||
| def log_hyperparams(self, params: Optional[Union[dict[str, Any], Namespace]] = None) -> None: | |||
| """Log hyperparameters to YAML format. | |||
There was a problem hiding this comment.
could we add the same docstring to the fabric CSVLogger
https://github.com/Lightning-AI/pytorch-lightning/blob/master/src/lightning/fabric/loggers/csv_logs.py
just copy paste
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?
Fixes #20724
Improves the CSVLogger documentation to clearly explain the distinction between CSV and YAML logging formats and provides comprehensive examples.
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--20951.org.readthedocs.build/en/20951/