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.

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

Fix pickling error with CSVLogger #10388

Merged
merged 3 commits into from
Nov 8, 2021

Conversation

EspenHa
Copy link
Contributor

@EspenHa EspenHa commented Nov 6, 2021

Fix pickling error with CSVLogger

Pickling CSVLogger will lead to an error if some metrics have been logged and .save has been called. This PR fixes that issue.

import pytorch_lightning as pl
import pickle

logger = pl.loggers.CSVLogger("test")

pickle.dumps(logger) # works fine

logger.log_metrics({"a": 1})
logger.save()

pickle.dumps(logger)  # crashes: TypeError: cannot pickle '_csv.writer' object

Fixes #10387

Does your PR introduce any breaking changes? If yes, please list them.

No

Before submitting

  • Was this discussed/approved 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 internal minor changes/refactorings)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing make sure you have read Review guidelines. In short, see the following bullet-list:

  • 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

Did you have fun?

Make sure you had fun coding 🙃

@awaelchli awaelchli added the bug Something isn't working label Nov 7, 2021
@awaelchli awaelchli added this to the 1.5.x milestone Nov 7, 2021
@awaelchli awaelchli added the logger Related to the Loggers label Nov 7, 2021
@awaelchli
Copy link
Contributor

awaelchli commented Nov 7, 2021

Thx for sending the fix @EspenHa. Could you add the lines

logger.log_metrics({"a": 1})
logger.save()

to the test tests/loggers/test_all.py::_test_loggers_pickle please?
And a changelog entry in the section "fixed" if possible.

@awaelchli awaelchli self-assigned this Nov 7, 2021
@EspenHa
Copy link
Contributor Author

EspenHa commented Nov 7, 2021

@awaelchli I improved the test and added a line in the changelog 👍

@justusschock justusschock enabled auto-merge (squash) November 8, 2021 09:36
@justusschock justusschock added the ready PRs ready to be merged label Nov 8, 2021
Copy link
Contributor

@tchaton tchaton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM ! Nice work !

@justusschock justusschock merged commit 89e1360 into Lightning-AI:master Nov 8, 2021
@EspenHa EspenHa deleted the fix_pickle_csv_logger branch November 8, 2021 10:57
awaelchli added a commit that referenced this pull request Nov 8, 2021
* Don't store csv.Dictwriter in ExperimentWriter

* Add test for pickle after .save()

* Add entry in changelog
awaelchli added a commit that referenced this pull request Nov 9, 2021
* Don't store csv.Dictwriter in ExperimentWriter

* Add test for pickle after .save()

* Add entry in changelog
lexierule pushed a commit that referenced this pull request Nov 9, 2021
* Don't store csv.Dictwriter in ExperimentWriter

* Add test for pickle after .save()

* Add entry in changelog
Raalsky pushed a commit to neptune-ai/pytorch-lightning that referenced this pull request Nov 23, 2021
* Don't store csv.Dictwriter in ExperimentWriter

* Add test for pickle after .save()

* Add entry in changelog
@rohitgr7 rohitgr7 mentioned this pull request Feb 7, 2022
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working logger Related to the Loggers ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Pickling error with CSVLogger
4 participants