tensorbored 2.21.0rc1769983804__py3-none-any.whl

tensorbored/default.py

@@ -0,0 +1,124 @@
+# Copyright 2019 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.
+# ==============================================================================
+"""Collection of first-party plugins.
+
+This module exists to isolate tensorboard.program from the potentially
+heavyweight build dependencies for first-party plugins. This way people
+doing custom builds of TensorBoard have the option to only pay for the
+dependencies they want.
+
+This module also grants the flexibility to those doing custom builds, to
+automatically inherit the centrally-maintained list of standard plugins,
+for less repetition.
+"""
+
+import logging
+
+import pkg_resources
+
+from tensorbored.plugins.audio import audio_plugin
+from tensorbored.plugins.core import core_plugin
+from tensorbored.plugins.custom_scalar import custom_scalars_plugin
+from tensorbored.plugins.debugger_v2 import debugger_v2_plugin
+from tensorbored.plugins.distribution import distributions_plugin
+from tensorbored.plugins.graph import graphs_plugin
+from tensorbored.plugins.histogram import histograms_plugin
+from tensorbored.plugins.hparams import hparams_plugin
+from tensorbored.plugins.image import images_plugin
+from tensorbored.plugins.metrics import metrics_plugin
+from tensorbored.plugins.pr_curve import pr_curves_plugin
+from tensorbored.plugins.profile_redirect import profile_redirect_plugin
+from tensorbored.plugins.scalar import scalars_plugin
+from tensorbored.plugins.text import text_plugin
+from tensorbored.plugins.mesh import mesh_plugin
+from tensorbored.plugins.wit_redirect import wit_redirect_plugin
+
+logger = logging.getLogger(__name__)
+
+
+# Ordering matters. The order in which these lines appear determines the
+# ordering of tabs in TensorBoard's GUI.
+_PLUGINS = [
+    core_plugin.CorePluginLoader(include_debug_info=True),
+    metrics_plugin.MetricsPlugin,
+    scalars_plugin.ScalarsPlugin,
+    custom_scalars_plugin.CustomScalarsPlugin,
+    images_plugin.ImagesPlugin,
+    audio_plugin.AudioPlugin,
+    debugger_v2_plugin.DebuggerV2Plugin,
+    graphs_plugin.GraphsPlugin,
+    distributions_plugin.DistributionsPlugin,
+    histograms_plugin.HistogramsPlugin,
+    text_plugin.TextPlugin,
+    pr_curves_plugin.PrCurvesPlugin,
+    profile_redirect_plugin.ProfileRedirectPluginLoader,
+    hparams_plugin.HParamsPlugin,
+    mesh_plugin.MeshPlugin,
+    wit_redirect_plugin.WITRedirectPluginLoader,
+]
+
+
+def get_plugins():
+    """Returns a list specifying all known TensorBoard plugins.
+
+    This includes both first-party, statically bundled plugins and
+    dynamic plugins.
+
+    This list can be passed to the `tensorboard.program.TensorBoard` API.
+
+    Returns:
+      The list of default first-party plugins.
+    """
+    return get_static_plugins() + get_dynamic_plugins()
+
+
+def get_static_plugins():
+    """Returns a list specifying TensorBoard's default first-party plugins.
+
+    Plugins are specified in this list either via a TBLoader instance to load the
+    plugin, or the TBPlugin class itself which will be loaded using a BasicLoader.
+
+    This list can be passed to the `tensorboard.program.TensorBoard` API.
+
+    Returns:
+      The list of default first-party plugins.
+
+    :rtype: list[Type[base_plugin.TBLoader] | Type[base_plugin.TBPlugin]]
+    """
+
+    return _PLUGINS[:]
+
+
+def get_dynamic_plugins():
+    """Returns a list specifying TensorBoard's dynamically loaded plugins.
+
+    A dynamic TensorBoard plugin is specified using entry_points [1] and it is
+    the robust way to integrate plugins into TensorBoard.
+
+    This list can be passed to the `tensorboard.program.TensorBoard` API.
+
+    Returns:
+      The list of dynamic plugins.
+
+    :rtype: list[Type[base_plugin.TBLoader] | Type[base_plugin.TBPlugin]]
+
+    [1]: https://packaging.python.org/specifications/entry-points/
+    """
+    return [
+        entry_point.resolve()
+        for entry_point in pkg_resources.iter_entry_points(
+            "tensorbored_plugins"
+        )
+    ]

tensorbored/errors.py

@@ -0,0 +1,130 @@
+# Copyright 2019 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.
+# ==============================================================================
+"""Error codes (experimental module).
+
+These types represent a subset of the Google error codes [1], which are
+also used by TensorFlow, gRPC, et al.
+
+When an HTTP handler raises one of these errors, the TensorBoard core
+application will catch it and automatically serve a properly formatted
+response with the error message.
+
+[1]: https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
+"""
+
+
+class PublicError(RuntimeError):
+    """An error whose text does not contain sensitive information.
+
+    Fields:
+      http_code: Integer between 400 and 599 inclusive (e.g., 404).
+      headers: List of additional key-value pairs to include in the
+        response body, like `[("Allow", "GET")]` for HTTP 405 or
+        `[("WWW-Authenticate", "Digest")]` for HTTP 401. May be empty.
+    """
+
+    http_code = 500  # default; subclasses should override
+
+    def __init__(self, details):
+        super().__init__(details)
+        self.headers = []
+
+
+class InvalidArgumentError(PublicError):
+    """Client specified an invalid argument.
+
+    The text of this error is assumed not to contain sensitive data,
+    and so may appear in (e.g.) the response body of a failed HTTP
+    request.
+
+    Corresponds to HTTP 400 Bad Request or Google error code `INVALID_ARGUMENT`.
+    """
+
+    http_code = 400
+
+    def __init__(self, details=None):
+        msg = _format_message("Invalid argument", details)
+        super().__init__(msg)
+
+
+class NotFoundError(PublicError):
+    """Some requested entity (e.g., file or directory) was not found.
+
+    The text of this error is assumed not to contain sensitive data,
+    and so may appear in (e.g.) the response body of a failed HTTP
+    request.
+
+    Corresponds to HTTP 404 Not Found or Google error code `NOT_FOUND`.
+    """
+
+    http_code = 404
+
+    def __init__(self, details=None):
+        msg = _format_message("Not found", details)
+        super().__init__(msg)
+
+
+class UnauthenticatedError(PublicError):
+    """Request does not have valid authentication credentials for the operation.
+
+    The text of this error is assumed not to contain sensitive data,
+    and so may appear in (e.g.) the response body of a failed HTTP
+    request.
+
+    Corresponds to HTTP 401 Unauthorized (despite the name) or Google
+    error code `UNAUTHENTICATED`. HTTP 401 responses are required to
+    contain a `WWW-Authenticate` challenge, so `UnauthenticatedError`
+    values are, too.
+    """
+
+    http_code = 401
+
+    def __init__(self, details=None, *, challenge):
+        """Initialize an `UnauthenticatedError`.
+
+        Args;
+          details: Optional public, user-facing error message, as a
+            string or any value that can be converted to string, or
+            `None` to omit details.
+          challenge: String value of the `WWW-Authenticate` HTTP header
+            as described in RFC 7235.
+        """
+        msg = _format_message("Unauthenticated", details)
+        super().__init__(msg)
+        self.headers.append(("WWW-Authenticate", challenge))
+
+
+class PermissionDeniedError(PublicError):
+    """The caller does not have permission to execute the specified operation.
+
+    The text of this error is assumed not to contain sensitive data,
+    and so may appear in (e.g.) the response body of a failed HTTP
+    request.
+
+    Corresponds to HTTP 403 Forbidden or Google error code `PERMISSION_DENIED`.
+    """
+
+    http_code = 403
+
+    def __init__(self, details=None):
+        msg = _format_message("Permission denied", details)
+        super().__init__(msg)
+
+
+def _format_message(code_name, details):
+    if details is None:
+        return code_name
+    else:
+        return "%s: %s" % (code_name, details)

tensorbored/lazy.py

@@ -0,0 +1,99 @@
+# Copyright 2017 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.
+# ==============================================================================
+"""TensorBoard is a webapp for understanding TensorFlow runs and graphs."""
+
+import functools
+import threading
+import types
+
+
+def lazy_load(name):
+    """Decorator to define a function that lazily loads the module 'name'.
+
+    This can be used to defer importing troublesome dependencies - e.g. ones that
+    are large and infrequently used, or that cause a dependency cycle -
+    until they are actually used.
+
+    Args:
+      name: the fully-qualified name of the module; typically the last segment
+        of 'name' matches the name of the decorated function
+
+    Returns:
+      Decorator function that produces a lazy-loading module 'name' backed by the
+      underlying decorated function.
+    """
+
+    def wrapper(load_fn):
+        # Wrap load_fn to call it exactly once and update __dict__ afterwards to
+        # make future lookups efficient (only failed lookups call __getattr__).
+        @_memoize
+        def load_once(self):
+            if load_once.loading:
+                raise ImportError(
+                    "Circular import when resolving LazyModule %r" % name
+                )
+            load_once.loading = True
+            try:
+                module = load_fn()
+            finally:
+                load_once.loading = False
+            self.__dict__.update(module.__dict__)
+            load_once.loaded = True
+            return module
+
+        load_once.loading = False
+        load_once.loaded = False
+
+        # Define a module that proxies getattr() and dir() to the result of calling
+        # load_once() the first time it's needed. The class is nested so we can close
+        # over load_once() and avoid polluting the module's attrs with our own state.
+        class LazyModule(types.ModuleType):
+            def __getattr__(self, attr_name):
+                return getattr(load_once(self), attr_name)
+
+            def __dir__(self):
+                return dir(load_once(self))
+
+            def __repr__(self):
+                if load_once.loaded:
+                    return "<%r via LazyModule (loaded)>" % load_once(self)
+                return (
+                    "<module %r via LazyModule (not yet loaded)>"
+                    % self.__name__
+                )
+
+        return LazyModule(name)
+
+    return wrapper
+
+
+def _memoize(f):
+    """Memoizing decorator for f, which must have exactly 1 hashable
+    argument."""
+    nothing = object()  # Unique "no value" sentinel object.
+    cache = {}
+    # Use a reentrant lock so that if f references the resulting wrapper we die
+    # with recursion depth exceeded instead of deadlocking.
+    lock = threading.RLock()
+
+    @functools.wraps(f)
+    def wrapper(arg):
+        if cache.get(arg, nothing) is nothing:
+            with lock:
+                if cache.get(arg, nothing) is nothing:
+                    cache[arg] = f(arg)
+        return cache[arg]
+
+    return wrapper

tensorbored/main.py

@@ -0,0 +1,48 @@
+# 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.
+# ==============================================================================
+"""TensorBoard main module.
+
+This module ties together `tensorboard.program` and
+`tensorboard.default_plugins` to provide standard TensorBoard. It's
+meant to be tiny and act as little other than a config file. Those
+wishing to customize the set of plugins or static assets that
+TensorBoard uses can swap out this file with their own.
+"""
+
+import sys
+
+from absl import app
+from tensorbored import default
+from tensorbored import main_lib
+from tensorbored import program
+from tensorbored.plugins import base_plugin
+from tensorbored.util import tb_logging
+
+logger = tb_logging.get_logger()
+
+
+def run_main():
+    """Initializes flags and calls main()."""
+    main_lib.global_init()
+    tensorboard = program.TensorBoard(plugins=default.get_plugins())
+    try:
+        app.run(tensorboard.main, flags_parser=tensorboard.configure)
+    except base_plugin.FlagsError as e:
+        print("Error: %s" % e, file=sys.stderr)
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    run_main()

tensorbored/main_lib.py

@@ -0,0 +1,62 @@
+# Copyright 2021 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.
+# ==============================================================================
+"""Helpers for TensorBoard main module."""
+
+import os
+import sys
+
+import absl.logging
+
+from tensorbored.compat import tf
+
+_TBDEV_SHUTDOWN_MESSAGE = """\
+======================================================================
+ERROR: The `tensorboard dev` command is no longer available.
+
+TensorBoard.dev has been shut down. For further information,
+see the FAQ at <https://tensorbored.dev/>.
+======================================================================
+"""
+
+
+def global_init():
+    """Modifies the global environment for running TensorBoard as main.
+
+    This functions changes global state in the Python process, so it should
+    not be called from library routines.
+    """
+    # TF versions prior to 1.15.0 included default GCS filesystem caching logic
+    # that interacted pathologically with the pattern of reads used by TensorBoard
+    # for logdirs. See: https://github.com/tensorflow/tensorboard/issues/1225
+    # The problematic behavior was fixed in 1.15.0 by
+    # https://github.com/tensorflow/tensorflow/commit/e43b94649d3e1ac5d538e4eca9166b899511d681
+    # but for older versions of TF, we avoid a regression by setting this env var to
+    # disable the cache, which must be done before the first import of tensorflow.
+    os.environ["GCS_READ_CACHE_DISABLED"] = "1"
+
+    if getattr(tf, "__version__", "stub") == "stub":
+        print(
+            "TensorFlow installation not found - running with reduced feature set.",
+            file=sys.stderr,
+        )
+
+    # Only emit log messages at WARNING and above by default to reduce spam.
+    absl.logging.set_verbosity(absl.logging.WARNING)
+
+    # Intercept attempts to invoke `tensorboard dev` and print turndown message.
+    if sys.argv[1:] and sys.argv[1] == "dev":
+        sys.stderr.write(_TBDEV_SHUTDOWN_MESSAGE)
+        sys.stderr.flush()
+        sys.exit(1)