From 90f38da337f1c2f4e80f6ca1c22da1b85cc0a160 Mon Sep 17 00:00:00 2001
From: Yating <ytjing@google.com>
Date: Fri, 12 Nov 2021 14:42:38 -0500
Subject: [PATCH] histogram: set v3 as default (#5415)

* set histogram v3 as default

* remove unused import

* keep the v2 version for now

* keep the v3 export to avoid breaking internal tests
---
 tensorboard/plugins/histogram/summary.py         |  7 +++++--
 tensorboard/plugins/histogram/summary_test.py    |  4 ++--
 tensorboard/plugins/histogram/summary_v2.py      |  6 +++++-
 .../plugins/metrics/metrics_plugin_test.py       | 16 ++++++++++------
 4 files changed, 22 insertions(+), 11 deletions(-)

diff --git a/tensorboard/plugins/histogram/summary.py b/tensorboard/plugins/histogram/summary.py
index a889fcbefe2..9ddd9787c9a 100644
--- a/tensorboard/plugins/histogram/summary.py
+++ b/tensorboard/plugins/histogram/summary.py
@@ -36,12 +36,15 @@
 
 
 # Export V2 versions.
-histogram = summary_v2.histogram
-histogram_pb = summary_v2.histogram_pb
+histogram_v2 = summary_v2.histogram_v2
 
 # Export V3 versions.
 histogram_v3 = summary_v2.histogram_v3
 
+# Export the default versions.
+histogram = summary_v2.histogram
+histogram_pb = summary_v2.histogram_pb
+
 
 def _buckets(data, bucket_count=None):
     """Create a TensorFlow op to group data into histogram buckets.
diff --git a/tensorboard/plugins/histogram/summary_test.py b/tensorboard/plugins/histogram/summary_test.py
index 89af32953ba..b3d12f3c3d0 100644
--- a/tensorboard/plugins/histogram/summary_test.py
+++ b/tensorboard/plugins/histogram/summary_test.py
@@ -240,7 +240,7 @@ def write_histogram_event(self, *args, **kwargs):
         writer.close()
 
     def call_histogram_op(self, *args, **kwargs):
-        summary.histogram(*args, **kwargs)
+        summary.histogram_v2(*args, **kwargs)
 
     def test_scoped_tag(self):
         with tf.name_scope("scope"):
@@ -306,7 +306,7 @@ def graph_fn():
 
 class SummaryV3OpTest(SummaryV2OpTest, tf.test.TestCase):
     def call_histogram_op(self, *args, **kwargs):
-        summary.histogram_v3(*args, **kwargs)
+        summary.histogram(*args, **kwargs)
 
     def test_singleton_input(self):
         pb = self.histogram("twelve", [12])
diff --git a/tensorboard/plugins/histogram/summary_v2.py b/tensorboard/plugins/histogram/summary_v2.py
index 1b850f25872..f1d76f96e93 100644
--- a/tensorboard/plugins/histogram/summary_v2.py
+++ b/tensorboard/plugins/histogram/summary_v2.py
@@ -46,7 +46,7 @@
 DEFAULT_BUCKET_COUNT = 30
 
 
-def histogram(name, data, step=None, buckets=None, description=None):
+def histogram_v2(name, data, step=None, buckets=None, description=None):
     """Write a histogram summary.
 
     See also `tf.summary.scalar`, `tf.summary.SummaryWriter`.
@@ -507,3 +507,7 @@ def when_single_value():
             )
 
         return tf.cond(is_empty, when_empty, when_nonempty)
+
+
+# Set V3 as default.
+histogram = histogram_v3
diff --git a/tensorboard/plugins/metrics/metrics_plugin_test.py b/tensorboard/plugins/metrics/metrics_plugin_test.py
index a719b949d73..95852b5727c 100644
--- a/tensorboard/plugins/metrics/metrics_plugin_test.py
+++ b/tensorboard/plugins/metrics/metrics_plugin_test.py
@@ -420,6 +420,14 @@ def test_time_series_histogram(self):
         )
         clean_response = self._clean_time_series_responses(response)
 
+        # By default 30 bins will be generated.
+        bins_zero = [{"min": 0, "max": 0, "count": 0}] * 29 + [
+            {"min": 0, "max": 0, "count": 1.0}
+        ]
+        bins_ten = [{"min": 10, "max": 10, "count": 0}] * 29 + [
+            {"min": 10, "max": 10, "count": 1.0}
+        ]
+
         self.assertEqual(
             [
                 {
@@ -431,16 +439,12 @@ def test_time_series_histogram(self):
                             {
                                 "wallTime": "<wall_time>",
                                 "step": 0,
-                                "bins": [
-                                    {"min": -0.5, "max": 0.5, "count": 1.0}
-                                ],
+                                "bins": bins_zero,
                             },
                             {
                                 "wallTime": "<wall_time>",
                                 "step": 1,
-                                "bins": [
-                                    {"min": 9.5, "max": 10.5, "count": 1.0}
-                                ],
+                                "bins": bins_ten,
                             },
                         ]
                     },