72 lines
2.5 KiB
Python
72 lines
2.5 KiB
Python
|
# 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 tensorboard.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,
|
||
|
|
)
|