Added support for pathlib paths as a logdir using the recommended os.PathLike class. #5905
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
arcra
requested changes
Aug 31, 2022
There was a problem hiding this comment.
This seems reasonable. I'll check with the team, but I don't think there would be objections to this. Would you mind adding a small test for it? There seems to already be a test for using an explicit writer:
github.com/tensorflow/tensorboard/blob/master/tensorboard/plugins/hparams/_keras_test.py#L133
|
Sounds very reasonable. |
arcra
requested changes
Sep 1, 2022
rileyajones
reviewed
Sep 13, 2022
rileyajones
reviewed
Sep 13, 2022
arcra
requested changes
Sep 14, 2022
additional linebreak Co-authored-by: Riley Jones <[email protected]>
removed trailing whitespace Co-authored-by: Riley Jones <[email protected]>
|
Thanks for the Change requests. |
rileyajones
approved these changes
Sep 22, 2022
| @@ -62,10 +62,14 @@ def __init__(self, writer, hparams, trial_id=None): | |||
| summary_v2.hparams_pb(self._hparams, trial_id=self._trial_id) | |||
| if writer is None: | |||
| raise TypeError( | |||
| "writer must be a `SummaryWriter` or `str`, not None" | |||
| "writer must be a `SummaryWriter`, `str` or `PathLike`, not None" | |||
There was a problem hiding this comment.
Just a nitpick here but it would be nice to keep the formatting consistent
Suggested change
| "writer must be a `SummaryWriter`, `str` or `PathLike`, not None" | |
| "writer must be a `SummaryWriter`, `str`, or `PathLike`, not None" |
| @@ -165,7 +174,7 @@ def test_reuse_failure(self): | |||
| def test_invalid_writer(self): | |||
| with self.assertRaisesRegex( | |||
| TypeError, | |||
| "writer must be a `SummaryWriter` or `str`, not None", | |||
| "writer must be a `SummaryWriter`, `str` or `PathLike`, not None", | |||
There was a problem hiding this comment.
Same comment as above
Suggested change
| "writer must be a `SummaryWriter`, `str` or `PathLike`, not None", | |
| "writer must be a `SummaryWriter`, `str`, or `PathLike`, not None" |
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.
Motivation for features / changes
Most other Tensorflow functions accept Paths in other form than strings.
This small change makes the plugin more consistent and users do not need to cast their Path objects to string manually.
Technical description of changes
elif isinstance(writer, os.PathLike):
self._writer = tf.compat.v2.summary.create_file_writer(os.fsdecode(writer))
Detailed steps to verify changes work correctly (as executed by you)
Barely tested to be honest. Just ran the tutorial code here: https://www.tensorflow.org/tensorboard/hyperparameter_tuning_with_hparams
with my version
Alternate designs / implementations considered
Once all Tensorflow functions accept pathlikes instead of just strings the distinction between str and PathLike will be unnecessary.