52 lines
1.8 KiB
Python
52 lines
1.8 KiB
Python
|
# Copyright 2020 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.
|
||
|
|
# ==============================================================================
|
||
|
|
"""Experimental plugin support for TensorBoard.
|
||
|
|
|
||
|
|
Contains the mechanism for marking plugins as experimental.
|
||
|
|
"""
|
||
|
|
|
||
|
|
|
||
|
|
class ExperimentalPlugin:
|
||
|
|
"""A marker class used to annotate a plugin as experimental.
|
||
|
|
|
||
|
|
Experimental plugins are hidden from users by default. The plugin will only
|
||
|
|
be enabled for a user if the user has specified the plugin with the
|
||
|
|
experimentalPlugin query parameter in the URL.
|
||
|
|
|
||
|
|
The marker class can annotate either TBPlugin or TBLoader instances, whichever
|
||
|
|
is most convenient.
|
||
|
|
|
||
|
|
Typical usage is to create a new class that inherits from both an existing
|
||
|
|
TBPlugin/TBLoader class and this marker class. For example:
|
||
|
|
|
||
|
|
class ExperimentalGraphsPlugin(
|
||
|
|
graphs_plugin.GraphsPlugin,
|
||
|
|
experimental_plugin.ExperimentalPlugin,
|
||
|
|
):
|
||
|
|
pass
|
||
|
|
|
||
|
|
|
||
|
|
class ExperimentalDebuggerPluginLoader(
|
||
|
|
debugger_plugin_loader.DebuggerPluginLoader,
|
||
|
|
experimental_plugin.ExperimentalPlugin
|
||
|
|
):
|
||
|
|
pass
|
||
|
|
|
||
|
|
Note: This class is itself an experimental mechanism and is subject to
|
||
|
|
modification or removal without warning.
|
||
|
|
"""
|
||
|
|
|
||
|
|
pass
|