Hparams: Support excluding metric information in HTTP requests. #6556
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
yatbear
approved these changes
Aug 23, 2023
| @@ -37,9 +41,15 @@ def run(self): | |||
| An Experiment object. | |||
| """ | |||
| experiment_id = self._experiment_id | |||
| include_metrics = ( | |||
| not self._request.HasField("include_metrics") | |||
There was a problem hiding this comment.
Nit: Could you add a comment for L45 to mention metrics are included by default (if this option is not specified), just to minimize cognitive load.
yatbear
pushed a commit
to yatbear/tensorboard
that referenced
this pull request
Aug 25, 2023
…orflow#6556) There are some clients of the Hparams HTTP API that do not require the metric information. This includes the metric_infos usually returned in the /experiments request and the metric_values usually returned in the /session_groups request. Since these can be expensive to calculate, we want the option to not calculate and return them in the response. Add option `include_metrics` to both GetExperimentRequest and ListSessionGroupsRequest. If unspecified we treat `include_metrics` as True, for backward compatibility. Honor the `include_metrics` property in all three major cases: When experiment metadata is defined by Experiment tags, by Session tags, or by the DataProvider.
bmd3k
added a commit
that referenced
this pull request
Nov 7, 2023
…le with hparams. (#6678) The runs table does not display any of the metric fields/data returned by the hparams plugin. We want to avoid unnecessarily calculating this data on the backend. The hparams plugin allows requests to specify an include_metrics parameter (added in #6556). We set this flag to false for all hparams-related requests coming from the "hparams_data_source". Testing: * Observed in both OSS and internal TensorBoard that setting this flag to False results in responses that do not include the metric data. * Observed that hparams in timeseries runs table still works. * Observed that hparams in experiment list runs table still works.
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.
There are some clients of the Hparams HTTP API that do not require the metric information. This includes the metric_infos usually returned in the /experiments request and the metric_values usually returned in the /session_groups request. Since these can be expensive to calculate, we want the option to not calculate and return them in the response.
Add option
include_metricsto both GetExperimentRequest and ListSessionGroupsRequest. If unspecified we treatinclude_metricsas True, for backward compatibility. Honor theinclude_metricsproperty in all three major cases: When experiment metadata is defined by Experiment tags, by Session tags, or by the DataProvider.