Change DebugString behavior to ShortDebugString

girving · keveman · commit c878ce6ae549 · 2016-01-20T10:38:46.000-08:00
The old behavior of DebugString is needlessly verbose and is quite confusing
for scalar shapes (it produced the empty string).  Now DebugString is the same
as ShortDebugString.

A future commit will remove ShortDebugString.
Change: 112590646
diff --git a/tensorflow/core/framework/tensor_shape.cc b/tensorflow/core/framework/tensor_shape.cc
@@ -149,12 +149,6 @@ TensorShapeIter TensorShape::end() const {
 }
 
 string TensorShape::DebugString() const {
-  TensorShapeProto proto;
-  AsProto(&proto);
-  return proto.ShortDebugString();
-}
-
-string TensorShape::ShortDebugString() const {
   return strings::StrCat(
       "[", str_util::Join(gtl::ArraySlice<int64>(dim_sizes_), ","), "]");
 }
diff --git a/tensorflow/core/framework/tensor_slice_test.cc b/tensorflow/core/framework/tensor_slice_test.cc
@@ -157,29 +157,20 @@ TEST(TensorSliceTest, SliceTensorShape) {
     TensorShape x({2, 4, 5, 8});
     TensorShape y;
     EXPECT_OK(a.SliceTensorShape(x, &y));
-    EXPECT_EQ(
-        "dim { size: 1 } "
-        "dim { size: 4 } "
-        "dim { size: 1 } "
-        "dim { size: 6 }",
-        y.DebugString());
+    EXPECT_EQ("[1,4,1,6]", y.DebugString());
   }
 
-  // An invalid application -- dimension 2 is out of bound
+  // An invalid application -- dimension 2 is out of bounds
   {
     TensorSlice a = TensorSlice::ParseOrDie("1,1:1,4:-:-");
     TensorShape x({2, 4, 5, 8});
     TensorShape y;
     EXPECT_EQ(
         "Internal: "
         "Extent in dimension 1 out of bounds: "
-        "shape = dim { size: 2 } "
-        "dim { size: 4 } "
-        "dim { size: 5 } "
-        "dim { size: 8 }, "
-        "slice = 1,1:1,4:-:-",
+        "shape = [2,4,5,8], slice = 1,1:1,4:-:-",
         a.SliceTensorShape(x, &y).ToString());
-    EXPECT_EQ("", y.DebugString());
+    EXPECT_EQ("[]", y.DebugString());
   }
 }
 
diff --git a/tensorflow/core/public/tensor_shape.h b/tensorflow/core/public/tensor_shape.h
@@ -124,13 +124,15 @@ class TensorShape {
 
   /// For error messages.
   string DebugString() const;
-  string ShortDebugString() const;
-  // TODO(vrv): Consolidate DebugString() and ShortDebugString() into one
-  // function that is not verbose and works for scalars.
+
+  /// Same as DebugString()
+  string ShortDebugString() const { return DebugString(); }
+  // TODO(irving): Remove, used to be different but isn't now.
 
   /// Same as `TensorShape(proto).ShortDebugString()` but doesn't crash for
   /// invalid protos.
   static string ShortDebugString(const TensorShapeProto& proto);
+  // TODO(irving): Rename to DebugString.
 
  private:
   // Recalculates the dimensions of this tensor after they are modified.
diff --git a/tensorflow/core/util/tensor_slice_reader_test.cc b/tensorflow/core/util/tensor_slice_reader_test.cc
@@ -115,10 +115,7 @@ void SimpleFloatHelper(TensorSliceWriter::CreateBuilderFunction create_function,
     TensorShape shape;
     DataType type;
     EXPECT_TRUE(reader.HasTensor("test", &shape, &type));
-    EXPECT_EQ(
-        "dim { size: 4 } "
-        "dim { size: 5 }",
-        shape.DebugString());
+    EXPECT_EQ("[4,5]", shape.DebugString());
     EXPECT_EQ(DT_FLOAT, type);
     EXPECT_FALSE(reader.HasTensor("don't exist", nullptr, nullptr));
   }
@@ -242,10 +239,7 @@ void SimpleIntXHelper(TensorSliceWriter::CreateBuilderFunction create_function,
     TensorShape shape;
     DataType type;
     EXPECT_TRUE(reader.HasTensor("test", &shape, &type));
-    EXPECT_EQ(
-        "dim { size: 4 } "
-        "dim { size: 5 }",
-        shape.DebugString());
+    EXPECT_EQ("[4,5]", shape.DebugString());
     EXPECT_EQ(DataTypeToEnum<T>::v(), type);
     EXPECT_FALSE(reader.HasTensor("don't exist", nullptr, nullptr));
   }
@@ -379,10 +373,7 @@ void CachedTensorSliceReaderTesterHelper(
     TensorShape shape;
     DataType type;
     EXPECT_TRUE(reader->HasTensor("test", &shape, &type));
-    EXPECT_EQ(
-        "dim { size: 4 } "
-        "dim { size: 5 }",
-        shape.DebugString());
+    EXPECT_EQ("[4,5]", shape.DebugString());
     EXPECT_EQ(DT_FLOAT, type);
     EXPECT_FALSE(reader->HasTensor("don't exist", nullptr, nullptr));
   }
diff --git a/tensorflow/python/kernel_tests/constant_op_test.py b/tensorflow/python/kernel_tests/constant_op_test.py
@@ -536,7 +536,7 @@ def testShape(self):
 
       with self.assertRaisesOpError(
           "must feed a value for placeholder tensor 'p' with dtype float and "
-          "shape dim { size: 10 } dim { size: 10 }"):
+          r"shape \[10,10\]"):
         p_identity.eval()
 
       with self.assertRaisesWithPredicateMatch(

Original file line number	Diff line number	Diff line change
`@@ -149,12 +149,6 @@ TensorShapeIter TensorShape::end() const {`
`149`	`149`	`}`
`150`	`150`
`151`	`151`	`string TensorShape::DebugString() const {`
`152`		`- TensorShapeProto proto;`
`153`		`- AsProto(&proto);`
`154`		`- return proto.ShortDebugString();`
`155`		`-}`
`156`		`-`
`157`		`-string TensorShape::ShortDebugString() const {`
`158`	`152`	`return strings::StrCat(`
`159`	`153`	`"[", str_util::Join(gtl::ArraySlice<int64>(dim_sizes_), ","), "]");`
`160`	`154`	`}`