PiperOrigin-RevId: 222102227

Author: MarkDaoust

site/en/install/source_windows.md

@@ -172,7 +172,8 @@ bazel build --config=opt --config=cuda --define=no_tensorflow_py_deps=true //ten
 
 #### Bazel build options
 
-Use this option when building to avoid issue with package creation: https://github.com/tensorflow/tensorflow/issues/22390
+Use this option when building to avoid issue with package creation:
+https://github.com/tensorflow/tensorflow/issues/22390
 
 <pre class="devsite-terminal tfo-terminal-windows devsite-click-to-copy">
 --define=no_tensorflow_py_deps=true

site/en/lite/README.md

@@ -2,4 +2,5 @@ Welcome to the warp zone!
 
 # TensorFlow Lite
 
-These docs are available here: https://github.com/tensorflow/tensorflow/tree/master/tensorflow/lite/g3doc
+These docs are available here:
+https://github.com/tensorflow/tensorflow/tree/master/tensorflow/lite/g3doc

site/en/tfx/README.md

@@ -4,6 +4,8 @@ Welcome to the warp zone!
 
 These docs are available here:
 
-* Data Validation: https://github.com/tensorflow/data-validation/tree/master/g3doc
-* Transform: https://github.com/tensorflow/transform/tree/master/docs
-* Model Analysis: https://github.com/tensorflow/model-analysis/tree/master/g3doc
+*   Data Validation:
+    https://github.com/tensorflow/data-validation/tree/master/g3doc
+*   Transform: https://github.com/tensorflow/transform/tree/master/docs
+*   Model Analysis:
+    https://github.com/tensorflow/model-analysis/tree/master/g3doc

tools/release_tools/update_versions.py

@@ -1,3 +1,17 @@
+# Copyright 2015 The TensorFlow Authors. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==============================================================================
 """Update tensorflow version in docs. Run this from the repo-root."""
 import argparse
 import re

tools/setup.py

@@ -56,8 +56,6 @@
   # enum introduced in Python 3.4
   REQUIRED_PKGS.append('enum34')
 
-print(find_packages())
-
 setup(
     name=project_name,
     version=version,
@@ -68,7 +66,7 @@
     url='http://github.com/tensorflow/docs',
     download_url='https://github.com/tensorflow/docs/tags',
     license='Apache 2.0',
-    packages= find_packages(),#['tensorflow_docs'],
+    packages=find_packages(),
     scripts=[],
     install_requires=REQUIRED_PKGS,
     extras_require={

tools/tensorflow_docs/api_generator/doc_controls.py

@@ -305,7 +305,7 @@ def should_skip_class_attr(cls, name):
       return False
 
   # for each parent class
-  for parent in cls.__mro__[1:]:
+  for parent in getattr(cls, "__mro__", [])[1:]:
     # if the class should be skipped, don't doc this object.
     if should_skip(parent):
       return True

tools/tensorflow_docs/api_generator/doc_generator_visitor.py

@@ -26,29 +26,35 @@
 class DocGeneratorVisitor(object):
   """A visitor that generates docs for a python object when __call__ed."""
 
-  def __init__(self, root_name=''):
+  def __init__(self):
     """Make a visitor.
 
-    As this visitor is starting its traversal at a module or class, it will not
-    be told the name of that object during traversal. `root_name` is the name it
-    should use for that object, effectively prefixing all names with
-    "root_name.".
-
-    Args:
-      root_name: The name of the root module/class.
+    This visitor expects to be called on each node in the api. It is passed the
+    path to an object, the object, and the filtered list of the object's
+    children. (see the `__call__` method for details.
+
+    This object accumulates the various data-structures necessary to build the
+    docs, including (see the property definitions for details.):
+
+    In the decsription below "master name" is the object's preferred fully
+    qualified name.
+
+    Params:
+      index: A mapping from master names to python python objects.
+      tree: A mapping from master names to a list if attribute names.
+      reverse_index: Mapping from python object ids to master names.
+        Note that this doesn't work for python numbers, strings or tuples.
+      duplicate_of: A mapping from a fully qualified names to the object's
+        master name. The master names are not included as keys.
+      duplicates: A mapping from master names to lists of other fully qualified
+        names for the object.
     """
-    self.set_root_name(root_name)
     self._index = {}
     self._tree = {}
     self._reverse_index = None
     self._duplicates = None
     self._duplicate_of = None
 
-  def set_root_name(self, root_name):
-    """Sets the root name for subsequent __call__s."""
-    self._root_name = root_name or ''
-    self._prefix = (root_name + '.') if root_name else ''
-
   @property
   def index(self):
     """A map from fully qualified names to objects to be documented.
@@ -118,19 +124,16 @@ def duplicates(self):
     self._maybe_find_duplicates()
     return self._duplicates
 
-  def _add_prefix(self, name):
-    """Adds the root name to a name."""
-    return self._prefix + name if name else self._root_name
-
-  def __call__(self, parent_name, parent, children):
+  def __call__(self, parent_path, parent, children):
     """Visitor interface, see `tensorflow/tools/common:traverse` for details.
 
     This method is called for each symbol found in a traversal using
     `tensorflow/tools/common:traverse`. It should not be called directly in
     user code.
 
     Args:
-      parent_name: The fully qualified name of a symbol found during traversal.
+      parent_path: A tuple of strings. The fully qualified path to a symbol
+        found during traversal.
       parent: The Python object referenced by `parent_name`.
       children: A list of `(name, py_object)` pairs enumerating, in alphabetical
         order, the children (as determined by `tf_inspect.getmembers`) of
@@ -140,7 +143,7 @@ def __call__(self, parent_name, parent, children):
       RuntimeError: If this visitor is called with a `parent` that is not a
         class or module.
     """
-    parent_name = self._add_prefix(parent_name)
+    parent_name = '.'.join(parent_path)
     self._index[parent_name] = parent
     self._tree[parent_name] = []
 
@@ -179,6 +182,8 @@ def _score_name(self, name):
     """
     parts = name.split('.')
     short_name = parts[-1]
+    if len(parts) == 1:
+      return (-99, -99, -99, short_name)
 
     container = self._index['.'.join(parts[:-1])]
 

tools/tensorflow_docs/api_generator/doc_generator_visitor_test.py

@@ -18,6 +18,7 @@
 from __future__ import division
 from __future__ import print_function
 
+import os
 import types
 
 from absl.testing import absltest
@@ -41,7 +42,7 @@ class DocGeneratorVisitorTest(absltest.TestCase):
   def test_call_module(self):
     visitor = doc_generator_visitor.DocGeneratorVisitor()
     visitor(
-        'doc_generator_visitor', doc_generator_visitor,
+        ('doc_generator_visitor',), doc_generator_visitor,
         [('DocGeneratorVisitor', doc_generator_visitor.DocGeneratorVisitor)])
 
     self.assertEqual({'doc_generator_visitor': ['DocGeneratorVisitor']},
@@ -55,21 +56,22 @@ def test_call_module(self):
   def test_call_class(self):
     visitor = doc_generator_visitor.DocGeneratorVisitor()
     visitor(
-        'DocGeneratorVisitor', doc_generator_visitor.DocGeneratorVisitor,
-        [('index', doc_generator_visitor.DocGeneratorVisitor.index)])
+        ('DocGeneratorVisitor',), doc_generator_visitor.DocGeneratorVisitor,
+        [('index', doc_generator_visitor.DocGeneratorVisitor.reverse_index)])
 
     self.assertEqual({'DocGeneratorVisitor': ['index']},
                      visitor.tree)
     self.assertEqual({
-        'DocGeneratorVisitor': doc_generator_visitor.DocGeneratorVisitor,
+        'DocGeneratorVisitor':
+            doc_generator_visitor.DocGeneratorVisitor,
         'DocGeneratorVisitor.index':
-        doc_generator_visitor.DocGeneratorVisitor.index
+            doc_generator_visitor.DocGeneratorVisitor.reverse_index
     }, visitor.index)
 
   def test_call_raises(self):
     visitor = doc_generator_visitor.DocGeneratorVisitor()
     with self.assertRaises(RuntimeError):
-      visitor('non_class_or_module', 'non_class_or_module_object', [])
+      visitor(('non_class_or_module',), 'non_class_or_module_object', [])
 
   def test_duplicates_module_class_depth(self):
 
@@ -79,12 +81,14 @@ class Nested(object):
         pass
 
     tf = types.ModuleType('tf')
+    tf.__file__ = '/tmp/tf/__init__.py'
     tf.Parent = Parent
     tf.submodule = types.ModuleType('submodule')
     tf.submodule.Parent = Parent
 
     visitor = generate_lib.extract(
         [('tf', tf)],
+        base_dir=os.path.dirname(tf.__file__),
         private_map={},
         do_not_descend_map={},
         visitor_cls=NoDunderVisitor)
@@ -120,13 +124,15 @@ class Parent(object):
       pass
 
     tf = types.ModuleType('tf')
+    tf.__file__ = '/tmp/tf/__init__.py'
     tf.contrib = types.ModuleType('contrib')
     tf.submodule = types.ModuleType('submodule')
     tf.contrib.Parent = Parent
     tf.submodule.Parent = Parent
 
     visitor = generate_lib.extract(
         [('tf', tf)],
+        base_dir=os.path.dirname(tf.__file__),
         private_map={},
         do_not_descend_map={},
         visitor_cls=NoDunderVisitor)
@@ -156,11 +162,13 @@ class Child(Parent):
       pass
 
     tf = types.ModuleType('tf')
+    tf.__file__ = '/tmp/tf/__init__.py'
     tf.Parent = Parent
     tf.Child = Child
 
     visitor = generate_lib.extract(
         [('tf', tf)],
+        base_dir=os.path.dirname(tf.__file__),
         private_map={},
         do_not_descend_map={},
         visitor_cls=NoDunderVisitor)
@@ -189,13 +197,15 @@ class Parent(object):
       pass
 
     tf = types.ModuleType('tf')
+    tf.__file__ = '/tmp/tf/__init__.py'
     tf.submodule = types.ModuleType('submodule')
     tf.submodule.submodule2 = types.ModuleType('submodule2')
     tf.Parent = Parent
     tf.submodule.submodule2.Parent = Parent
 
     visitor = generate_lib.extract(
         [('tf', tf)],
+        base_dir=os.path.dirname(tf.__file__),
         private_map={},
         do_not_descend_map={},
         visitor_cls=NoDunderVisitor)
@@ -223,11 +233,13 @@ class Parent(object):
     Parent.obj2 = Parent.obj1
 
     tf = types.ModuleType('tf')
+    tf.__file__ = '/tmp/tf/__init__.py'
     tf.submodule = types.ModuleType('submodule')
     tf.submodule.Parent = Parent
 
     visitor = generate_lib.extract(
         [('tf', tf)],
+        base_dir=os.path.dirname(tf.__file__),
         private_map={},
         do_not_descend_map={},
         visitor_cls=NoDunderVisitor)