Merge remote-tracking branch 'upstream/master' into polymer2

Author: stephanwlee

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,40 @@
+---
+name: Bug report
+about: Report a problem in TensorBoard
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+Consider Stack Overflow for getting support using TensorBoard—they have
+a larger community with better searchability:
+
+https://stackoverflow.com/questions/tagged/tensorboard
+
+Do not use this template for for setup, installation, or configuration
+issues. Instead, use the “installation problem” issue template:
+
+https://github.com/tensorflow/tensorboard/issues/new?template=installation_problem.md
+
+To report a problem with TensorBoard itself, please fill out the
+remainder of this template.
+
+## Environment information (required)
+
+Please run `diagnose_tensorboard.py` (link below) in the same
+environment from which you normally run TensorFlow/TensorBoard, and
+paste the output here:
+
+https://raw.githubusercontent.com/tensorflow/tensorboard/master/tensorboard/tools/diagnose_tensorboard.py
+
+For browser-related issues, please additionally specify:
+
+  - Browser type and version (e.g., Chrome 64.0.3282.140):
+  - Screenshot, if it’s a visual issue:
+
+## Issue description
+
+Please describe the bug as clearly as possible. How can we reproduce the
+problem without additional resources (including external data files and
+proprietary Python modules)?

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,11 @@
+---
+name: Feature request
+about: Suggest an enhancement to TensorBoard
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+Please describe the problem that you’re facing and the enhancements that
+you’d like to see. Feel free to include screenshots or code samples.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,31 @@
+---
+name: Installation problem
+about: Report a problem installing or starting TensorBoard
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+Use this template if you have a problem building, installing,
+configuring, or starting TensorBoard and you suspect that there is a
+problem with TensorBoard itself.
+
+Consider first reaching out to Stack Overflow for support—they have a
+larger community with better searchability:
+
+https://stackoverflow.com/questions/tagged/tensorboard
+
+## Environment information (required)
+
+Please run `diagnose_tensorboard.py` (link below) in the same
+environment from which you normally run TensorFlow/TensorBoard, and
+paste the output here:
+
+https://raw.githubusercontent.com/tensorflow/tensorboard/master/tensorboard/tools/diagnose_tensorboard.py
+
+## Steps to reproduce (required)
+
+Please provide explicit commands to reproduce the problem in a fresh
+environment (virtualenv, Conda environment, …). Include any necessary
+configuration, such as Conda `environment.yml` files.

.github/ISSUE_TEMPLATE/installation_problem.md

@@ -1,14 +1,9 @@
 dist: trusty
-sudo: required
-
 language: python
 python:
   - "2.7"
   - "3.6"
 
-os:
-  - linux
-
 branches:
   only:
     - master
@@ -29,141 +24,98 @@ env:
     - TF_VERSION_ID=  # Do not install TensorFlow in this case
 
 cache:
+  # Reuse the pip cache directory across build machines.
+  pip: true
+  # Cache directories for Bazel. See ci/bazelrc for details.
   directories:
-    - $HOME/.bazel-output-base
+    - $HOME/.cache/tb-bazel-repo
+    - $HOME/.cache/tb-bazel-disk
 
 # Each bullet point is displayed in the Travis log as one collapsed line, which
 # indicates how long it took. Travis will check the return code at the end. We
 # can't use `set -e` in the YAML file since it might impact Travis internals.
 # If inline scripts get too long, Travis surprisingly prints them twice.
 
 before_install:
-  # Travis pre-installs an old version of numpy. We uninstall it to
-  # reduce the potential for strange behavior when upgrading in-place
-  # for TensorFlow's numpy dependency.
-  - pip uninstall -y numpy
-  - pip freeze  # print installed distributions, for debugging purposes
-  - |
-    # Download Bazel
-    bazel_binary="$(mktemp)" &&
-    bazel_checksum_file="$(mktemp)" &&
-    printf >"${bazel_checksum_file}" \
-        '%s  %s\n' "${BAZEL_SHA256SUM}" "${bazel_binary}" &&
-    for url in \
-        "https://mirror.bazel.build/github.com/bazelbuild/bazel/releases/download/${BAZEL}/bazel-${BAZEL}-linux-x86_64" \
-        "https://github.com/bazelbuild/bazel/releases/download/${BAZEL}/bazel-${BAZEL}-linux-x86_64" \
-    ; do
-      if \
-          wget -t 3 -O "${bazel_binary}" "${url}" &&
-          shasum -a 256 --check "${bazel_checksum_file}"; then
-        break
-      else
-        rm -f "${bazel_binary}"
-      fi
-    done &&
-    rm "${bazel_checksum_file}" &&
-    [ -f "${bazel_binary}" ]
-  - chmod +x "${bazel_binary}"
-  - sudo mv "${bazel_binary}" /usr/local/bin/bazel
-
-  # Fix Boto and Travis issue https://github.com/travis-ci/travis-ci/issues/7940
-  - sudo rm -f /etc/boto.cfg
-
-  # Storing build artifacts in this directory helps Travis cache them. This
-  # will sometimes cut latency in half, when we're lucky.
-  - echo "startup --output_base=${HOME}/.bazel-output-base" >>~/.bazelrc
-
-  # Travis Trusty Sudo GCE VMs have 2 cores and 7.5 GB RAM. These settings
-  # help Bazel go faster and not OOM the system.
-  - echo "startup --host_jvm_args=-Xms500m" >>~/.bazelrc
-  - echo "startup --host_jvm_args=-Xmx500m" >>~/.bazelrc
-  - echo "startup --host_jvm_args=-XX:-UseParallelGC" >>~/.bazelrc
-  - echo "build --local_resources=400,2,1.0" >>~/.bazelrc
-  - echo "build --worker_max_instances=2" >>~/.bazelrc
-
-  # Make Bazel as strict as possible, so TensorBoard will build correctly
-  # for users, regardless of their Bazel configuration.
-  - echo "build --worker_verbose" >>~/.bazelrc
-  - echo "build --worker_sandboxing" >>~/.bazelrc
-  - echo "build --spawn_strategy=sandboxed" >>~/.bazelrc
-  - echo "build --genrule_strategy=sandboxed" >>~/.bazelrc
-  - echo "test --test_verbose_timeout_warnings" >>~/.bazelrc
-
-  # It's helpful to see the errors on failure.
-  - echo "build --verbose_failures" >>~/.bazelrc
-  - echo "test --test_output=errors" >>~/.bazelrc
-
-  # We need to pass the PATH from our virtualenv down into our tests,
-  # which is non-hermetic and so disabled by default in Bazel 0.21.0+.
-  - echo "test --action_env=PATH" >>~/.bazelrc
+  - elapsed() { TZ=UTC printf "Time %(%T)T %s\n" "$SECONDS" "$1"; }
+  - elapsed "before_install"
+  - ci/download_bazel.sh "${BAZEL}" "${BAZEL_SHA256SUM}" ~/bazel
+  - sudo mv ~/bazel /usr/local/bin/bazel
+  - cp ci/bazelrc ~/.bazelrc
+  - elapsed "before_install (done)"
 
 install:
-  - pip install boto3==1.9.86
+  - elapsed "install"
+  # Lint check deps.
   - pip install flake8==3.5.0
+  - pip install yamllint==1.5.0
+  # TensorBoard deps.
   - pip install futures==3.1.1
   - pip install grpcio==1.6.3
-  - pip install moto==1.3.7
-  - pip install yamllint==1.5.0
+  # Uninstall older Travis numpy to avoid upgrade-in-place issues.
+  - pip uninstall -y numpy
   - |
     # Install TensorFlow if requested
     if [ -n "${TF_VERSION_ID}" ]; then
       pip install -I "${TF_VERSION_ID}"
     else
-      # Requirements typically found through TensorFlow
-      pip install "absl-py>=0.7.0"
-      pip install "numpy<2.0,>=1.14.5"
+      # Requirements typically found through TensorFlow.
+      pip install "absl-py>=0.7.0" \
+      && pip install "numpy<2.0,>=1.14.5"
     fi
+  # Deps for gfile S3 test.
+  - pip install boto3==1.9.86
+  - pip install moto==1.3.7
+  # Workaround for https://github.com/travis-ci/travis-ci/issues/7940
+  - sudo rm -f /etc/boto.cfg
+  - elapsed "install (done)"
 
 before_script:
-  # fail the build if there are Python syntax errors or undefined names
+  - elapsed "before_script"
+  # Do a fail-fast check for Python syntax errors or undefined names.
+  # Use the comment '# noqa: <error code>' to suppress.
   - flake8 . --count --select=E901,E999,F821,F822,F823 --show-source --statistics
-  # exit-zero treats all errors as warnings.  The GitHub editor is 127 chars wide
-  # a comment of '# noqa' or better yet '# noqa: <error code>' added to the code to silence flake8
-  - flake8 . --count --exit-zero --ignore=E111,E114 --max-complexity=10 --max-line-length=127 --statistics
   # Lint .yaml docs files. Use '# yamllint disable-line rule:foo' to suppress.
   - yamllint -c docs/.yamllint docs docs/.yamllint
+  # Make sure that IPython notebooks have valid Markdown.
+  - tensorboard/tools/docs_list_format_test.sh
   # Make sure we aren't accidentally including work-in-progress code.
   - tensorboard/tools/do_not_submit_test.sh
   # Make sure all necessary files have the license information.
   - tensorboard/tools/license_test.sh
-  # Make sure that IPython notebooks have valid Markdown.
-  - tensorboard/tools/docs_list_format_test.sh
-
-# Commands in this section should only fail if it's our fault. Travis will
-# categorize them as 'failed', rather than 'error' for other sections.
-script:
-  # Note: bazel test implies fetch+build, but this gives us timing.
-  - bazel fetch //tensorboard/...
-  - bazel build //tensorboard/...
+  # Make sure that build URLs are valid.
+  - tensorboard/tools/mirror_urls_test.sh
+  # Make sure that files have no trailing whitespace.
+  - tensorboard/tools/whitespace_hygiene_test.py
   - |
-    # When TensorFlow is not installed, run a restricted subset of tests.
+    # Specify subset of tests to run depending on TF installation config.
+    # We condition the value of --test_tag_filters so that we can run the
+    # bazel test command unconditionally which produces nicer log output.
     if [ -z "${TF_VERSION_ID}" ]; then
       test_tag_filters=support_notf
     else
       test_tag_filters=
     fi
-  - bazel test //tensorboard/... --test_tag_filters="${test_tag_filters}"
+  - elapsed "before_script (done)"
+
+# Commands in this section should only fail if it's our fault. Travis will
+# categorize them as 'failed', rather than 'error' for other sections.
+script:
+  - elapsed "script"
+  # Note: bazel test implies fetch+build, but this gives us timing.
+  - elapsed && bazel fetch //tensorboard/...
+  - elapsed && bazel build //tensorboard/...
+  - elapsed && bazel test //tensorboard/... --test_tag_filters="${test_tag_filters}"
+  - elapsed && bazel run //tensorboard/pip_package:test_pip_package -- --default-python-only --tf-version "${TF_VERSION_ID}"
   # Run manual S3 test
-  - bazel test //tensorboard/compat/tensorflow_stub:gfile_s3_test
-  - bazel run //tensorboard/pip_package:build_pip_package -- --tf-version "${TF_VERSION_ID}" --smoke
+  - elapsed && bazel test //tensorboard/compat/tensorflow_stub:gfile_s3_test
+  - elapsed && bazel test //tensorboard/summary/writer:event_file_writer_s3_test
+  - elapsed "script (done)"
 
 after_script:
   # Bazel launches daemons unless --batch is used.
+  - elapsed "after_script"
   - bazel shutdown
 
-before_cache:
-  - |
-    # Scrub tiny build artifacts not worth caching.
-    find "${HOME}/.bazel-output-base" \
-      -name \*.runfiles -print0 \
-      -or -name \*.tar.gz -print0 \
-      -or -name \*-execroot.json -print0 \
-      -or -name \*-tsc.json -print0 \
-      -or -name \*-params.pbtxt -print0 \
-      -or -name \*-args.txt -print0 \
-      -or -name \*.runfiles_manifest -print0 \
-      -or -name \*.server_params.pbtxt -print0 \
-      | xargs -0 rm -rf
-
 notifications:
   email: false

.travis.yml

@@ -1,4 +1,4 @@
-# TensorBoard [![Travis build status](https://www.travis-ci.com/tensorflow/tensorboard.svg?branch=master)](https://travis-ci.com/tensorflow/tensorboard/)
+# TensorBoard [![Travis build status](https://www.travis-ci.com/tensorflow/tensorboard.svg?branch=master)](https://travis-ci.com/tensorflow/tensorboard/) [![Compat check PyPI](https://python-compatibility-tools.appspot.com/one_badge_image?package=tensorboard)](https://python-compatibility-tools.appspot.com/one_badge_target?package=tensorboard)
 
 TensorBoard is a suite of web applications for inspecting and understanding your
 TensorFlow runs and graphs.
@@ -7,20 +7,20 @@ This README gives an overview of key concepts in TensorBoard, as well as how to
 interpret the visualizations TensorBoard provides. For an in-depth example of
 using TensorBoard, see the tutorial: [TensorBoard: Visualizing
 Learning][].
-For in-depth information on the Graph Visualizer, see this tutorial: 
+For in-depth information on the Graph Visualizer, see this tutorial:
 [TensorBoard: Graph Visualization][].
 
 [TensorBoard: Visualizing Learning]: https://www.tensorflow.org/get_started/summaries_and_tensorboard
 [TensorBoard: Graph Visualization]: https://www.tensorflow.org/get_started/graph_viz
 
 You may also want to watch
 [this video tutorial][] that walks
-through setting up and using TensorBoard. There's an associated 
+through setting up and using TensorBoard. There's an associated
 [tutorial with an end-to-end example of training TensorFlow and using TensorBoard][].
 
 [this video tutorial]: https://www.youtube.com/watch?v=eBbEDRsCmv4
 
-[tutorial with an end-to-end example of training TensorFlow and using TensorBoard]: https://github.com/dandelionmane/tf-dev-summit-tensorboard-tutorial
+[tutorial with an end-to-end example of training TensorFlow and using TensorBoard]: https://github.com/martinwicke/tf-dev-summit-tensorboard-tutorial
 
 # Usage
 
@@ -33,7 +33,7 @@ directory by creating a summary writer:
 file_writer = tf.summary.FileWriter('/path/to/logs', sess.graph)
 ```
 
-For more details, see 
+For more details, see
 [the TensorBoard tutorial](https://www.tensorflow.org/get_started/summaries_and_tensorboard).
 Once you have event files, run TensorBoard and provide the log directory. If
 you're using a precompiled TensorFlow package (e.g. you installed via pip), run:
@@ -66,7 +66,7 @@ work, but there may be bugs or performance issues.
 ### Summary Ops: How TensorBoard gets data from TensorFlow
 
 The first step in using TensorBoard is acquiring data from your TensorFlow run.
-For this, you need 
+For this, you need
 [summary ops](https://www.tensorflow.org/api_docs/python/tf/summary).
 Summary ops are ops, like
 [`tf.matmul`](https://www.tensorflow.org/versions/r1.2/api_docs/python/tf/matmul)