Skip to content

Commit 6568ab5

Browse files
authored
Adds small documentation about unused subcommands feature. (#6731)
Since this functionality is no longer used, I wanted to add some context for why it exists and the fact that it is actually not used anymore (or at least at the moment).
1 parent 94129a8 commit 6568ab5

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

tensorboard/program.py

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,8 @@ def __init__(
113113
server_class: An optional factory for a `TensorBoardServer` to use
114114
for serving the TensorBoard WSGI app. If provided, its callable
115115
signature should match that of `TensorBoardServer.__init__`.
116+
subcommands: An optional list of TensorBoardSubcommand objects, which
117+
extend the functionality of the CLI.
116118
117119
:type plugins:
118120
list[
@@ -502,7 +504,16 @@ def _should_use_data_server(flags):
502504

503505

504506
class TensorBoardSubcommand(metaclass=ABCMeta):
505-
"""Experimental private API for defining subcommands to tensorboard(1)."""
507+
"""Experimental private API for defining subcommands for tensorboard.
508+
509+
The intended use is something like:
510+
511+
`tensorboard <sub_cmd_name> <additional_args...>`
512+
513+
Since our hosted service at http://tensorboard.dev has been shut down, this
514+
functionality is no longer used, but the support for subcommands remains,
515+
in case it is ever useful again.
516+
"""
506517

507518
@abstractmethod
508519
def name(self):

0 commit comments

Comments
 (0)