tensorboard API reference
123 public APIs from tensorboard (tensorflow/tensorboard) — 96 classes, 13 functions, 14 methods. Signatures extracted by static analysis of the actual source.
Repository: tensorflow/tensorboard
| Kind | Count |
|---|---|
| Classes | 96 |
| Functions | 13 |
| Methods | 14 |
API list
class
tensorboard.auth.AuthContextAuthentication context within the scope of a single request.
class
tensorboard.auth.AuthProviderAuthentication provider for a specific kind of credential.
class
tensorboard.backend.empty_path_redirect.EmptyPathRedirectMiddlewareWSGI middleware to redirect from "" to "/".
class
tensorboard.backend.event_processing.event_accumulator.AudioEventContains information of an audio event.
class
tensorboard.backend.event_processing.event_accumulator.HistogramEventContains information of a histogram event.
class
tensorboard.backend.event_processing.event_accumulator.HistogramValueHolds the information of the histogram values.
class
tensorboard.backend.event_processing.event_accumulator.ImageEventContains information of an image event.
class
tensorboard.backend.event_processing.event_accumulator.ScalarEventContains information of a scalar event.
class
tensorboard.backend.event_processing.event_accumulator.TensorEventA tensor event.
class
tensorboard.backend.event_processing.event_file_loader.LegacyEventFileLoaderAn iterator that yields parsed Event protos.
class
tensorboard.backend.event_processing.plugin_event_accumulator.TensorEventA tensor event.
class
tensorboard.backend.path_prefix.PathPrefixMiddlewareWSGI middleware for path prefixes.
class
tensorboard.backend.security_validator.DirectiveContent security policy directive.
class
tensorboard.compat.tensorflow_stub.dtypes.DTypeRepresents the type of the elements in a `Tensor`.
class
tensorboard.compat.tensorflow_stub.errors.CancelledErrorRaised when an operation or step is cancelled.
class
tensorboard.compat.tensorflow_stub.errors.OpErrorA generic error that is raised when TensorFlow execution fails.
class
tensorboard.compat.tensorflow_stub.errors.ResourceExhaustedErrorSome resource has been exhausted.
class
tensorboard.compat.tensorflow_stub.errors.UnavailableErrorRaised when the runtime is currently unavailable.
class
tensorboard.compat.tensorflow_stub.errors.UnknownErrorUnknown error.
class
tensorboard.compat.tensorflow_stub.errors.raise_exception_on_not_ok_statusContext manager to check for C API status.
class
tensorboard.compat.tensorflow_stub.io.gfile.FSSpecFileSystemProvides filesystem access via fsspec.
method
tensorboard.compat.tensorflow_stub.io.gfile.FSSpecFileSystem.join(path, *paths)Join paths with a slash.
class
tensorboard.compat.tensorflow_stub.io.gfile.LocalFileSystemProvides local fileystem access.
method
tensorboard.compat.tensorflow_stub.io.gfile.LocalFileSystem.join(path, *paths)Join paths with path delimiter.
class
tensorboard.compat.tensorflow_stub.io.gfile.S3FileSystemProvides filesystem access to S3.
method
tensorboard.compat.tensorflow_stub.io.gfile.S3FileSystem.join(path, *paths)Join paths with a slash.
class
tensorboard.compat.tensorflow_stub.io.gfile.StatDataData returned from the Stat call.
func
tensorboard.compat.tensorflow_stub.pywrap_tensorflow.crc_finalize(crc)Finalize CRC-32C checksum.
class
tensorboard.compat.tensorflow_stub.tensor_shape.DimensionRepresents the value of one dimension in a TensorShape.
class
tensorboard.compat.tensorflow_stub.tensor_shape.TensorShapeRepresents the shape of a `Tensor`.
func
tensorboard.compat.tensorflow_stub.tensor_shape.as_dimension(value)Converts the given value to a Dimension.
class
tensorboard.context.RequestContextContainer of request-scoped values.
class
tensorboard.data.grpc_provider.GrpcDataProviderData provider that talks over gRPC.
class
tensorboard.data.ingester.DataIngesterLink between a data source and a data provider.
method
tensorboard.data.ingester.DataIngester.data_provider()Returns a `DataProvider`.
method
tensorboard.data.ingester.DataIngester.start()Starts ingesting data.
class
tensorboard.data.provider.BlobReferenceA reference to a blob.
class
tensorboard.data.provider.ExperimentMetadataMetadata about an experiment.
class
tensorboard.data.provider.HyperparameterMetadata about a hyperparameter.
class
tensorboard.data.provider.HyperparameterFilterA constraint based on hyperparameter value.
class
tensorboard.data.provider.HyperparameterFilterTypeDescribes how to represent filter values.
class
tensorboard.data.provider.HyperparameterSessionRunA single run in a HyperparameterSessionGroup.
class
tensorboard.data.provider.HyperparameterSortA sort criterium based on hyperparameter value.
class
tensorboard.data.provider.HyperparameterSortDirectionDescribes which direction to sort a value.
class
tensorboard.data.provider.HyperparameterValueA hyperparameter value.
class
tensorboard.data.provider.ListHyperparametersResultThe result from calling list_hyperparameters().
class
tensorboard.data.provider.RunMetadata about a run.
class
tensorboard.data.provider.RunTagFilterFilters data by run and tag names.
class
tensorboard.data.provider.ScalarDatumA single datum in a scalar time series for a run and tag.
class
tensorboard.data.provider.TensorDatumA single datum in a tensor time series for a run and tag.
class
tensorboard.data.server_ingester.ExistingServerDataIngesterConnect to an already running gRPC server.
class
tensorboard.data.server_ingester.ServerBinaryInformation about a data server binary.
class
tensorboard.data.server_ingester.SubprocessServerDataIngesterStart a new data server as a subprocess.
class
tensorboard.errors.InvalidArgumentErrorClient specified an invalid argument.
class
tensorboard.errors.PublicErrorAn error whose text does not contain sensitive information.
func
tensorboard.load_ipython_extension(ipython)IPython API entry point.
func
tensorboard.main.run_main()Initializes flags and calls main().
func
tensorboard.main_dev.run_main()Initializes flags and calls main().
class
tensorboard.manager.StartExecFailedPossible return value of the `start` function.
class
tensorboard.manager.StartFailedPossible return value of the `start` function.
class
tensorboard.manager.StartLaunchedPossible return value of the `start` function.
class
tensorboard.manager.StartReusedPossible return value of the `start` function.
class
tensorboard.manager.StartTimedOutPossible return value of the `start` function.
class
tensorboard.manager.TensorBoardInfoHolds the information about a running TensorBoard instance.
class
tensorboard.plugins.audio.audio_plugin.AudioPluginAudio Plugin for TensorBoard.
class
tensorboard.plugins.base_plugin.BasicLoaderSimple TBLoader that's sufficient for most plugins.
class
tensorboard.plugins.base_plugin.FrontendMetadataMetadata required to render a plugin on the frontend.
class
tensorboard.plugins.base_plugin.TBLoaderTBPlugin factory base class.
class
tensorboard.plugins.base_plugin.TBPluginTensorBoard plugin interface.
method
tensorboard.plugins.base_plugin.TBPlugin.data_plugin_names()Experimental.
class
tensorboard.plugins.core.core_plugin.CorePluginCore plugin for TensorBoard.
class
tensorboard.plugins.core.core_plugin.CorePluginLoaderCorePlugin factory.
method
tensorboard.plugins.core.core_plugin.CorePluginLoader.load(context)Creates CorePlugin instance.
class
tensorboard.plugins.custom_scalar.custom_scalars_plugin.CustomScalarsPluginCustomScalars Plugin for TensorBoard.
class
tensorboard.plugins.debugger_v2.debugger_v2_plugin.DebuggerV2PluginDebugger V2 Plugin for TensorBoard.
class
tensorboard.plugins.distribution.compressor.CompressedHistogramValueRepresents a value in a compressed histogram.
class
tensorboard.plugins.distribution.distributions_plugin.DistributionsPluginDistributions Plugin for TensorBoard.
func
tensorboard.plugins.graph.graphs_demo.write_graph()Demonstrate basic graph writing.
class
tensorboard.plugins.graph.graphs_plugin.GraphsPluginGraphs Plugin for TensorBoard.
class
tensorboard.plugins.histogram.histograms_plugin.HistogramsPluginHistograms Plugin for TensorBoard.
class
tensorboard.plugins.hparams._keras.CallbackCallback for logging hyperparameters to TensorBoard.
class
tensorboard.plugins.hparams.download_data.HandlerHandles a DownloadData request.
class
tensorboard.plugins.hparams.error.HParamsErrorRepresents an error that is meaningful to the end-user.
class
tensorboard.plugins.hparams.get_experiment.HandlerHandles a GetExperiment request.
func
tensorboard.plugins.hparams.hparams_demo.prepare_data()Load and normalize data.
class
tensorboard.plugins.hparams.hparams_plugin.HParamsPluginHParams Plugin for TensorBoard.
method
tensorboard.plugins.hparams.hparams_plugin.HParamsPlugin.get_plugin_apps()See base class.
class
tensorboard.plugins.hparams.list_metric_evals.HandlerHandles a ListMetricEvals request.
method
tensorboard.plugins.hparams.list_metric_evals.Handler.run()Executes the request.
class
tensorboard.plugins.hparams.list_session_groups.HandlerHandles a ListSessionGroups request.
class
tensorboard.plugins.hparams.summary_v2.DiscreteA domain that takes on a fixed set of values.
class
tensorboard.plugins.hparams.summary_v2.DomainThe domain of a hyperparameter.
class
tensorboard.plugins.hparams.summary_v2.HParamA hyperparameter in an experiment.
class
tensorboard.plugins.hparams.summary_v2.MetricA metric in an experiment.
class
tensorboard.plugins.image.images_plugin.ImagesPluginImages Plugin for TensorBoard.
func
tensorboard.plugins.image.summary_v2.image(name, data, step=None, max_outputs=3, description=None)Write an image summary.
class
tensorboard.plugins.mesh.mesh_plugin.MeshPluginA plugin that serves 3D visualization of meshes.
class
tensorboard.plugins.mesh.metadata.MeshTensorA mesh tensor.
class
tensorboard.plugins.metrics.metrics_loader.MetricsLoaderThe loader for MetricsPlugin.
class
tensorboard.plugins.metrics.metrics_plugin.MetricsPluginMetrics Plugin for TensorBoard.
class
tensorboard.plugins.projector.projector_plugin.EmbeddingMetadataMetadata container for an embedding.
class
tensorboard.plugins.projector.projector_plugin.LRUCacheLRU cache.
class
tensorboard.plugins.projector.projector_plugin.ProjectorPluginEmbedding projector.
class
tensorboard.plugins.scalar.scalars_plugin.ScalarsPluginScalars Plugin for TensorBoard.
func
tensorboard.plugins.scalar.summary_v2.scalar(name, data, step=None, description=None)Write a scalar summary.
func
tensorboard.plugins.text.summary_v2.text(name, data, step=None, description=None)Write a text summary.
class
tensorboard.plugins.text.text_plugin.TextPluginText Plugin for TensorBoard.
class
tensorboard.program.TensorBoardClass for running TensorBoard.
class
tensorboard.program.TensorBoardServerClass for customizing TensorBoard WSGI app serving.
class
tensorboard.summary._output.OutputInterface for emitting tensor-formatted summary data.
class
tensorboard.summary._writer.WriterWrites summary data for visualization in TensorBoard.
method
tensorboard.summary._writer.Writer.add_scalar(tag, data, step, *wall_time=None, *description=None)Adds a scalar summary.
method
tensorboard.summary._writer.Writer.flush()Flushes any buffered data.
class
tensorboard.summary.writer.event_file_writer.EventFileWriterWrites `Event` protocol buffers to an event file.
class
tensorboard.test.TestCaseTensorBoard base test class.
class
tensorboard.uploader.upload_tracker.UploadStatsStatistics of uploading.
method
tensorboard.uploader.upload_tracker.UploadStats.add_blob(blob_bytes, is_skipped)Add a blob.
method
tensorboard.uploader.upload_tracker.UploadStats.add_plugin(plugin_name)Add a plugin.
method
tensorboard.uploader.upload_tracker.UploadStats.add_scalars(num_scalars)Add a batch of scalars.
class
tensorboard.uploader.upload_tracker.UploadTrackerTracker for uploader progress and status.
func
tensorboard.util.img_mime_type_detector.from_bytes(img_bytes:bytes) -> strReturns the MIME type of an image from its bytes.
func
tensorboard.util.tb_logging.get_logger()Returns TensorBoard logger.
func
tensorboard.util.tensor_util.make_tensor_proto(values, dtype=None, shape=None, verify_shape=False)Create a TensorProto.
About this data
These signatures were extracted from the public source of tensorflow/tensorboard
using Python's ast module. Argument names, default values,
type annotations and return types are taken verbatim from the code.
Implementation bodies are never stored. See
how it works for details.