tensorbored 2.21.0rc1769983804__py3-none-any.whl

tensorbored/plugins/hparams/download_data.py

@@ -0,0 +1,158 @@
+# Copyright 2019 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.
+# ==============================================================================
+"""Classes and functions for handling the DownloadData API call."""
+
+import csv
+import io
+import math
+
+from tensorbored.plugins.hparams import error
+
+
+class OutputFormat:
+    """An enum used to list the valid output formats for API calls."""
+
+    JSON = "json"
+    CSV = "csv"
+    LATEX = "latex"
+
+
+class Handler:
+    """Handles a DownloadData request."""
+
+    def __init__(
+        self,
+        context,
+        experiment,
+        session_groups,
+        response_format,
+        columns_visibility,
+    ):
+        """Constructor.
+
+        Args:
+          context: A backend_context.Context instance.
+          experiment: Experiment proto.
+          session_groups: ListSessionGroupsResponse proto.
+          response_format: A string in the OutputFormat enum.
+          columns_visibility: A list of boolean values to filter columns.
+        """
+        self._context = context
+        self._experiment = experiment
+        self._session_groups = session_groups
+        self._response_format = response_format
+        self._columns_visibility = columns_visibility
+
+    def run(self):
+        """Handles the request specified on construction.
+
+        Returns:
+          A response body.
+          A mime type (string) for the response.
+        """
+        experiment = self._experiment
+        session_groups = self._session_groups
+        response_format = self._response_format
+        visibility = self._columns_visibility
+
+        header = []
+        for hparam_info in experiment.hparam_infos:
+            header.append(hparam_info.display_name or hparam_info.name)
+
+        for metric_info in experiment.metric_infos:
+            header.append(metric_info.display_name or metric_info.name.tag)
+
+        def _filter_columns(row):
+            return [value for value, visible in zip(row, visibility) if visible]
+
+        header = _filter_columns(header)
+
+        rows = []
+
+        def _get_value(value):
+            if value.HasField("number_value"):
+                return value.number_value
+            if value.HasField("string_value"):
+                return value.string_value
+            if value.HasField("bool_value"):
+                return value.bool_value
+            # hyperparameter values can be optional in a session group
+            return ""
+
+        def _get_metric_id(metric):
+            return metric.group + "." + metric.tag
+
+        for group in session_groups.session_groups:
+            row = []
+            for hparam_info in experiment.hparam_infos:
+                row.append(_get_value(group.hparams[hparam_info.name]))
+            metric_values = {}
+            for metric_value in group.metric_values:
+                metric_id = _get_metric_id(metric_value.name)
+                metric_values[metric_id] = metric_value.value
+            for metric_info in experiment.metric_infos:
+                metric_id = _get_metric_id(metric_info.name)
+                row.append(metric_values.get(metric_id))
+            rows.append(_filter_columns(row))
+
+        if response_format == OutputFormat.JSON:
+            mime_type = "application/json"
+            body = dict(header=header, rows=rows)
+        elif response_format == OutputFormat.LATEX:
+
+            def latex_format(value):
+                if value is None:
+                    return "-"
+                elif isinstance(value, int):
+                    return "$%d$" % value
+                elif isinstance(value, float):
+                    if math.isnan(value):
+                        return r"$\mathrm{NaN}$"
+                    if value in (float("inf"), float("-inf")):
+                        return r"$%s\infty$" % ("-" if value < 0 else "+")
+                    scientific = "%.3g" % value
+                    if "e" in scientific:
+                        coefficient, exponent = scientific.split("e")
+                        return "$%s\\cdot 10^{%d}$" % (
+                            coefficient,
+                            int(exponent),
+                        )
+                    return "$%s$" % scientific
+                return value.replace("_", "\\_").replace("%", "\\%")
+
+            mime_type = "application/x-latex"
+            top_part = "\\begin{table}[tbp]\n\\begin{tabular}{%s}\n" % (
+                "l" * len(header)
+            )
+            header_part = (
+                " & ".join(map(latex_format, header)) + " \\\\ \\hline\n"
+            )
+            middle_part = "".join(
+                " & ".join(map(latex_format, row)) + " \\\\\n" for row in rows
+            )
+            bottom_part = "\\hline\n\\end{tabular}\n\\end{table}\n"
+            body = top_part + header_part + middle_part + bottom_part
+        elif response_format == OutputFormat.CSV:
+            string_io = io.StringIO()
+            writer = csv.writer(string_io)
+            writer.writerow(header)
+            writer.writerows(rows)
+            body = string_io.getvalue()
+            mime_type = "text/csv"
+        else:
+            raise error.HParamsError(
+                "Invalid reponses format: %s" % response_format
+            )
+        return body, mime_type

tensorbored/plugins/hparams/error.py

@@ -0,0 +1,26 @@
+# Copyright 2019 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.
+# ==============================================================================
+"""Defines an error (exception) class for the HParams plugin."""
+
+
+class HParamsError(Exception):
+    """Represents an error that is meaningful to the end-user.
+
+    Such an error should have a meaningful error message. Other errors,
+    (such as resulting from some internal invariants being violated)
+    should be represented by other exceptions.
+    """
+
+    pass

tensorbored/plugins/hparams/get_experiment.py

@@ -0,0 +1,71 @@
+# Copyright 2019 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.
+# ==============================================================================
+"""Classes and functions for handling the GetExperiment API call."""
+
+from tensorbored.plugins.hparams import api_pb2
+
+
+class Handler:
+    """Handles a GetExperiment request."""
+
+    def __init__(
+        self, request_context, backend_context, experiment_id, request
+    ):
+        """Constructor.
+
+        Args:
+          request_context: A tensorboard.context.RequestContext.
+          backend_context: A backend_context.Context instance.
+          experiment_id: A string, as from `plugin_util.experiment_id`.
+          request: A request proto.
+        """
+        self._request_context = request_context
+        self._backend_context = backend_context
+        self._experiment_id = experiment_id
+        self._include_metrics = (
+            # Metrics are included by default if include_metrics is not
+            # specified in the request.
+            not request.HasField("include_metrics")
+            or request.include_metrics
+        )
+        self._hparams_limit = (
+            request.hparams_limit
+            if isinstance(request, api_pb2.GetExperimentRequest)
+            else None
+        )
+
+    def run(self):
+        """Handles the request specified on construction.
+
+        Returns:
+          An Experiment object.
+        """
+        data_provider_hparams = (
+            self._backend_context.hparams_from_data_provider(
+                self._request_context,
+                self._experiment_id,
+                limit=self._hparams_limit,
+            )
+        )
+        return self._backend_context.experiment_from_metadata(
+            self._request_context,
+            self._experiment_id,
+            self._include_metrics,
+            self._backend_context.hparams_metadata(
+                self._request_context, self._experiment_id
+            ),
+            data_provider_hparams,
+            self._hparams_limit,
+        )

tensorbored/plugins/hparams/hparams_plugin.py

@@ -0,0 +1,206 @@
+# Copyright 2019 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.
+# ==============================================================================
+"""The TensorBoard HParams plugin.
+
+See `http_api.md` in this directory for specifications of the routes for
+this plugin.
+"""
+
+import json
+
+import werkzeug
+from werkzeug import wrappers
+
+from tensorbored import plugin_util
+from tensorbored.plugins.hparams import api_pb2
+from tensorbored.plugins.hparams import backend_context
+from tensorbored.plugins.hparams import download_data
+from tensorbored.plugins.hparams import error
+from tensorbored.plugins.hparams import get_experiment
+from tensorbored.plugins.hparams import list_metric_evals
+from tensorbored.plugins.hparams import list_session_groups
+from tensorbored.plugins.hparams import metadata
+from google.protobuf import json_format
+from tensorbored.backend import http_util
+from tensorbored.plugins import base_plugin
+from tensorbored.plugins.scalar import metadata as scalars_metadata
+from tensorbored.util import tb_logging
+
+logger = tb_logging.get_logger()
+
+
+class HParamsPlugin(base_plugin.TBPlugin):
+    """HParams Plugin for TensorBoard.
+
+    It supports both GETs and POSTs. See 'http_api.md' for more details.
+    """
+
+    plugin_name = metadata.PLUGIN_NAME
+
+    def __init__(self, context):
+        """Instantiates HParams plugin via TensorBoard core.
+
+        Args:
+          context: A base_plugin.TBContext instance.
+        """
+        self._context = backend_context.Context(context)
+
+    def get_plugin_apps(self):
+        """See base class."""
+
+        return {
+            "/download_data": self.download_data_route,
+            "/experiment": self.get_experiment_route,
+            "/session_groups": self.list_session_groups_route,
+            "/metric_evals": self.list_metric_evals_route,
+        }
+
+    def is_active(self):
+        return False  # `list_plugins` as called by TB core suffices
+
+    def frontend_metadata(self):
+        return base_plugin.FrontendMetadata(element_name="tf-hparams-dashboard")
+
+    # ---- /download_data- -------------------------------------------------------
+    @wrappers.Request.application
+    def download_data_route(self, request):
+        ctx = plugin_util.context(request.environ)
+        experiment_id = plugin_util.experiment_id(request.environ)
+        try:
+            response_format = request.args.get("format")
+            columns_visibility = json.loads(
+                request.args.get("columnsVisibility")
+            )
+            request_proto = _parse_request_argument(
+                request, api_pb2.ListSessionGroupsRequest
+            )
+            session_groups = list_session_groups.Handler(
+                ctx, self._context, experiment_id, request_proto
+            ).run()
+            experiment = get_experiment.Handler(
+                ctx, self._context, experiment_id, request_proto
+            ).run()
+            body, mime_type = download_data.Handler(
+                self._context,
+                experiment,
+                session_groups,
+                response_format,
+                columns_visibility,
+            ).run()
+            return http_util.Respond(request, body, mime_type)
+        except error.HParamsError as e:
+            logger.error("HParams error: %s" % e)
+            raise werkzeug.exceptions.BadRequest(description=str(e))
+
+    # ---- /experiment -----------------------------------------------------------
+    @wrappers.Request.application
+    def get_experiment_route(self, request):
+        ctx = plugin_util.context(request.environ)
+        experiment_id = plugin_util.experiment_id(request.environ)
+        try:
+            request_proto = _parse_request_argument(
+                request, api_pb2.GetExperimentRequest
+            )
+            response_proto = get_experiment.Handler(
+                ctx,
+                self._context,
+                experiment_id,
+                request_proto,
+            ).run()
+            response = plugin_util.proto_to_json(response_proto)
+            return http_util.Respond(
+                request,
+                response,
+                "application/json",
+            )
+        except error.HParamsError as e:
+            logger.error("HParams error: %s" % e)
+            raise werkzeug.exceptions.BadRequest(description=str(e))
+
+    # ---- /session_groups -------------------------------------------------------
+    @wrappers.Request.application
+    def list_session_groups_route(self, request):
+        ctx = plugin_util.context(request.environ)
+        experiment_id = plugin_util.experiment_id(request.environ)
+        try:
+            request_proto = _parse_request_argument(
+                request, api_pb2.ListSessionGroupsRequest
+            )
+            response_proto = list_session_groups.Handler(
+                ctx,
+                self._context,
+                experiment_id,
+                request_proto,
+            ).run()
+            response = plugin_util.proto_to_json(response_proto)
+            return http_util.Respond(
+                request,
+                response,
+                "application/json",
+            )
+        except error.HParamsError as e:
+            logger.error("HParams error: %s" % e)
+            raise werkzeug.exceptions.BadRequest(description=str(e))
+
+    # ---- /metric_evals ---------------------------------------------------------
+    @wrappers.Request.application
+    def list_metric_evals_route(self, request):
+        ctx = plugin_util.context(request.environ)
+        experiment_id = plugin_util.experiment_id(request.environ)
+        try:
+            request_proto = _parse_request_argument(
+                request, api_pb2.ListMetricEvalsRequest
+            )
+            scalars_plugin = self._get_scalars_plugin()
+            if not scalars_plugin:
+                raise werkzeug.exceptions.NotFound("Scalars plugin not loaded")
+            return http_util.Respond(
+                request,
+                list_metric_evals.Handler(
+                    ctx, request_proto, scalars_plugin, experiment_id
+                ).run(),
+                "application/json",
+            )
+        except error.HParamsError as e:
+            logger.error("HParams error: %s" % e)
+            raise werkzeug.exceptions.BadRequest(description=str(e))
+
+    def _get_scalars_plugin(self):
+        """Tries to get the scalars plugin.
+
+        Returns:
+        The scalars plugin or None if it is not yet registered.
+        """
+        return self._context.tb_context.plugin_name_to_instance.get(
+            scalars_metadata.PLUGIN_NAME
+        )
+
+
+def _parse_request_argument(request, proto_class):
+    request_json = (
+        request.data
+        if request.method == "POST"
+        else request.args.get("request")
+    )
+    try:
+        return json_format.Parse(request_json, proto_class())
+    # if request_json is None, json_format.Parse will throw an AttributeError:
+    # 'NoneType' object has no attribute 'decode'.
+    except (AttributeError, json_format.ParseError) as e:
+        raise error.HParamsError(
+            "Expected a JSON-formatted request data of type: {}, but got {} ".format(
+                proto_class, request_json
+            )
+        ) from e

tensorbored/plugins/hparams/hparams_util_pb2.py

@@ -0,0 +1,69 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: tensorbored/plugins/hparams/hparams_util.proto
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import message as _message
+from google.protobuf import reflection as _reflection
+from google.protobuf import symbol_database as _symbol_database
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+from google.protobuf import struct_pb2 as google_dot_protobuf_dot_struct__pb2
+from tensorbored.plugins.hparams import api_pb2 as tensorbored_dot_plugins_dot_hparams_dot_api__pb2
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n.tensorbored/plugins/hparams/hparams_util.proto\x12\x13tensorbored.hparams\x1a\x1cgoogle/protobuf/struct.proto\x1a%tensorbored/plugins/hparams/api.proto\"H\n\x0fHParamInfosList\x12\x35\n\x0chparam_infos\x18\x01 \x03(\x0b\x32\x1f.tensorbored.hparams.HParamInfo\"H\n\x0fMetricInfosList\x12\x35\n\x0cmetric_infos\x18\x01 \x03(\x0b\x32\x1f.tensorbored.hparams.MetricInfo\"\x8d\x01\n\x07HParams\x12:\n\x07hparams\x18\x01 \x03(\x0b\x32).tensorbored.hparams.HParams.HparamsEntry\x1a\x46\n\x0cHparamsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12%\n\x05value\x18\x02 \x01(\x0b\x32\x16.google.protobuf.Value:\x02\x38\x01\x62\x06proto3')
+
+
+
+_HPARAMINFOSLIST = DESCRIPTOR.message_types_by_name['HParamInfosList']
+_METRICINFOSLIST = DESCRIPTOR.message_types_by_name['MetricInfosList']
+_HPARAMS = DESCRIPTOR.message_types_by_name['HParams']
+_HPARAMS_HPARAMSENTRY = _HPARAMS.nested_types_by_name['HparamsEntry']
+HParamInfosList = _reflection.GeneratedProtocolMessageType('HParamInfosList', (_message.Message,), {
+  'DESCRIPTOR' : _HPARAMINFOSLIST,
+  '__module__' : 'tensorbored.plugins.hparams.hparams_util_pb2'
+  # @@protoc_insertion_point(class_scope:tensorbored.hparams.HParamInfosList)
+  })
+_sym_db.RegisterMessage(HParamInfosList)
+
+MetricInfosList = _reflection.GeneratedProtocolMessageType('MetricInfosList', (_message.Message,), {
+  'DESCRIPTOR' : _METRICINFOSLIST,
+  '__module__' : 'tensorbored.plugins.hparams.hparams_util_pb2'
+  # @@protoc_insertion_point(class_scope:tensorbored.hparams.MetricInfosList)
+  })
+_sym_db.RegisterMessage(MetricInfosList)
+
+HParams = _reflection.GeneratedProtocolMessageType('HParams', (_message.Message,), {
+
+  'HparamsEntry' : _reflection.GeneratedProtocolMessageType('HparamsEntry', (_message.Message,), {
+    'DESCRIPTOR' : _HPARAMS_HPARAMSENTRY,
+    '__module__' : 'tensorbored.plugins.hparams.hparams_util_pb2'
+    # @@protoc_insertion_point(class_scope:tensorbored.hparams.HParams.HparamsEntry)
+    })
+  ,
+  'DESCRIPTOR' : _HPARAMS,
+  '__module__' : 'tensorbored.plugins.hparams.hparams_util_pb2'
+  # @@protoc_insertion_point(class_scope:tensorbored.hparams.HParams)
+  })
+_sym_db.RegisterMessage(HParams)
+_sym_db.RegisterMessage(HParams.HparamsEntry)
+
+if _descriptor._USE_C_DESCRIPTORS == False:
+
+  DESCRIPTOR._options = None
+  _HPARAMS_HPARAMSENTRY._options = None
+  _HPARAMS_HPARAMSENTRY._serialized_options = b'8\001'
+  _HPARAMINFOSLIST._serialized_start=140
+  _HPARAMINFOSLIST._serialized_end=212
+  _METRICINFOSLIST._serialized_start=214
+  _METRICINFOSLIST._serialized_end=286
+  _HPARAMS._serialized_start=289
+  _HPARAMS._serialized_end=430
+  _HPARAMS_HPARAMSENTRY._serialized_start=360
+  _HPARAMS_HPARAMSENTRY._serialized_end=430
+# @@protoc_insertion_point(module_scope)

tensorbored/plugins/hparams/json_format_compat.py

@@ -0,0 +1,38 @@
+# Copyright 2023 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.
+# ==============================================================================
+
+import math
+
+
+def is_serializable_value(value):
+    """Returns whether a protobuf Value will be serializable by MessageToJson.
+
+    The json_format documentation states that "attempting to serialize NaN or
+    Infinity results in error."
+
+    https://protobuf.dev/reference/protobuf/google.protobuf/#value
+
+    Args:
+      value: A value of type protobuf.Value.
+
+    Returns:
+      True if the Value should be serializable without error by MessageToJson.
+      False, otherwise.
+    """
+    if not value.HasField("number_value"):
+        return True
+
+    number_value = value.number_value
+    return not math.isnan(number_value) and not math.isinf(number_value)

tensorbored/plugins/hparams/list_metric_evals.py

@@ -0,0 +1,57 @@
+# Copyright 2019 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.
+# ==============================================================================
+"""Classes and functions for handling the ListMetricEvals API call."""
+
+from tensorbored.plugins.hparams import metrics
+from tensorbored.plugins.scalar import scalars_plugin
+
+
+class Handler:
+    """Handles a ListMetricEvals request."""
+
+    def __init__(
+        self, request_context, request, scalars_plugin_instance, experiment
+    ):
+        """Constructor.
+
+        Args:
+            request_context: A tensorboard.context.RequestContext.
+            request: A ListSessionGroupsRequest protobuf.
+            scalars_plugin_instance: A scalars_plugin.ScalarsPlugin.
+            experiment: A experiment ID, as a possibly-empty `str`.
+        """
+        self._request_context = request_context
+        self._request = request
+        self._scalars_plugin_instance = scalars_plugin_instance
+        self._experiment = experiment
+
+    def run(self):
+        """Executes the request.
+
+        Returns:
+            An array of tuples representing the metric evaluations--each of the
+            form (<wall time in secs>, <training step>, <metric value>).
+        """
+        run, tag = metrics.run_tag_from_session_and_metric(
+            self._request.session_name, self._request.metric_name
+        )
+        body, _ = self._scalars_plugin_instance.scalars_impl(
+            self._request_context,
+            tag,
+            run,
+            self._experiment,
+            scalars_plugin.OutputFormat.JSON,
+        )
+        return body