Hparams: Update docstrings (#6633)

Googlers, see b/292102513 for context. #hparams
tensorflow · Oct 17, 2023 · 945710f · 945710f
1 parent e4c5ecc
commit 945710f
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/tensorboard/data/provider.py b/tensorboard/data/provider.py
@@ -227,7 +227,8 @@ def read_scalars(
           plugin_name: String name of the TensorBoard plugin that created
             the data to be queried. Required.
           downsample: Integer number of steps to which to downsample the
-            results (e.g., `1000`). See `DataProvider` class docstring
+            results (e.g., `1000`). The most recent datum (last scalar)
+            should always be included. See `DataProvider` class docstring
             for details about this parameter. Required.
           run_tag_filter: Optional `RunTagFilter` value. If provided, a time
             series will only be included in the result if its run and tag

diff --git a/tensorboard/plugins/hparams/backend_context.py b/tensorboard/plugins/hparams/backend_context.py
@@ -190,9 +190,8 @@ def read_last_scalars(self, ctx, experiment_id, run_tag_filter):
             experiment_id=experiment_id,
             plugin_name=scalar_metadata.PLUGIN_NAME,
             run_tag_filter=run_tag_filter,
-            # TODO(#3436): We assume that downsampling always includes
-            # the most recent datum, which holds for all implementations
-            # of interest but is not yet required by the interface.
+            # `read_scalars` always includes the most recent datum, therefore
+            # downsampling to one means fetching the latest value.
             downsample=1,
         )
         return {