Skip to content

Commit

Permalink
pip: depend on tensorboard-data-server (tensorflow#4676)
Browse files Browse the repository at this point in the history
Summary:
The `tensorboard` Pip package now depends on `tensorboard-data-server`.
Thus, users of standard TensorBoard may now pass `--load_fast` on
supported platforms. Users can still install TensorBoard even on a
platform that does not support the data server, because the data server
package includes a universal binary (`*-py3-none-any.whl`). This package
can always be installed, but does not implement any functionality, and
so attempting to use it with `--load_fast` will fail at runtime.

For now, we pin to exactly the v0.3.x minor series so that we can more
comfortably make breaking changes to the data server.

Test Plan:
Run `//tensorboard/pip_package:extract_pip_package` and install the
resulting wheel into a fresh virtualenv. Note that both TensorBoard and
the data server are installed, and that launching TensorBoard with
`--load_fast --verbosity 0` (a) logs that the data server is being
launched “from Python package” and (b) loads fast.

wchargin-branch: pip-data-server-dep
  • Loading branch information
wchargin authored Feb 10, 2021
1 parent 510d225 commit c4fa1df
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
5 changes: 2 additions & 3 deletions tensorboard/data/server_ingester.py
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,6 @@ def _get_server_binary():
return pkg_result

raise RuntimeError(
"TensorBoard data server not found. This mode is experimental "
"and not supported in release builds. If building from source, "
"pass --define=link_data_server=true."
"TensorBoard data server not found. This mode is experimental. "
"If building from source, pass --define=link_data_server=true."
)
1 change: 1 addition & 0 deletions tensorboard/pip_package/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ numpy >= 1.12.0
protobuf >= 3.6.0
requests >= 2.21.0, < 3
setuptools >= 41.0.0
tensorboard-data-server >= 0.3.0, < 0.4.0
tensorboard-plugin-wit >= 1.6.0
werkzeug >= 0.11.15
# python3 specifically requires wheel 0.26
Expand Down

0 comments on commit c4fa1df

Please sign in to comment.