U
VcoW @ s d Z ddlZddlZddlZddlmZ ddlmZ ddlmZ ddl m
Z
ddl m Z ddl
mZ dd lmZ dd lmZ dd lmZ dd lmZ d
d d d
ddZdZeejejgZeejgZ dd Z dd Z dd Z dd Z dd Z!dd Z"d d Z#d d Z$G d!d" d"ej%Z&dS )#z The TensorBoard metrics plugin. N)wrappers)errors) plugin_util) http_util)provider) base_plugin)metadataz image/bmpz image/gifz
image/jpegz image/pngz
image/svg+xml)ZbmpZgifZjpegZpngsvgzapplication/octet-streamc C sj t t}t t}| D ]D\}}| D ]2\}}|j}t|r,|| | || | q,q ||fS )a Gets maps from tags to descriptions, and descriptions to runs.
Args:
mapping: a nested map `d` such that `d[run][tag]` is a time series
produced by DataProvider's `list_*` methods.
Returns:
A tuple containing
tag_to_descriptions: A map from tag strings to a set of description
strings.
description_to_runs: A map from description strings to a set of run
strings.
) collections defaultdictsetitems descriptionlenadd)mappingtag_to_descriptionsdescription_to_runsruntag_to_contenttag metadatumr r N/tmp/pip-unpacked-wheel-g8kmtpbc/tensorboard/plugins/metrics/metrics_plugin.py_get_tag_description_info4 s
r c C sl g }| D ]P}t || }t|dkr(dnd}d| d d| }|d | }|| qd}|d| S ) a Creates a single description from a set of descriptions.
Descriptions may be composites when a single tag has different descriptions
across multiple runs.
Args:
descriptions: A list of description strings.
description_to_runs: A map from description strings to a set of run
strings.
Returns:
The combined description string.
runsr z## For z: z,
z# Multiple descriptions
)sortedr joinappend) descriptionsr Zprefixed_descriptionsr r Z run_or_runsZ
run_headerZdescription_htmlheaderr r r _build_combined_descriptionN s r# c C sX t | \}}i }|D ]>}t|| }t|dkr:|d }n
t||}t|||< q|S )a Returns a map of tags to descriptions.
Args:
mapping: a nested map `d` such that `d[run][tag]` is a time series
produced by DataProvider's `list_*` methods.
Returns:
A map from tag strings to description HTML strings. E.g.
{
"loss": "Multiple descriptions
For runs: test, train
...
",
"loss2": "The lossy details
",
}
r r )r r r r# r Zmarkdown_to_safe_html)r r r resultr r! r r r r _get_tag_to_descriptionh s
r% c s fdd D S )aM Returns a map of run names to a list of tag names.
Args:
mapping: a nested map `d` such that `d[run][tag]` is a time series
produced by DataProvider's `list_*` methods.
Returns:
A map from run strings to a list of tag strings. E.g.
{"loss001a": ["actor/loss", "critic/loss"], ...}
c s i | ]}|t | qS r )r .0r r r r
s z%_get_run_tag_info..r r( r r( r _get_run_tag_info s r* c C s t | t| dS )a Prepares a scalar or histogram mapping for client consumption.
Args:
mapping: a nested map `d` such that `d[run][tag]` is a time series
produced by DataProvider's `list_*` methods.
Returns:
A dict with the following fields:
runTagInfo: the return type of `_get_run_tag_info`
tagDescriptions: the return type of `_get_tag_to_description`
)Z
runTagInfotagDescriptions)r* r% r( r r r _format_basic_mapping s
r, c C sH |d }g }| D ]2}t |j|kr$q||j|j|j| jd q|S )a Formats image metadata from a list of BlobSequenceDatum's for clients.
This expects that frontend clients need to access images based on the
run+tag+sample.
Args:
sorted_datum_list: a list of DataProvider's `BlobSequenceDatum`, sorted by
step. This can be produced via DataProvider's `read_blob_sequences`.
sample: zero-indexed integer for the requested sample.
Returns:
A list of `ImageStepDatum` (see http_api.md).
)stepwallTimeimageId)r valuesr r. wall_timeblob_key)Zsorted_datum_listsampleindexZ step_datadatumr r r !_format_image_blob_sequence_datum s
r7 c C sL t t}| D ]0\}}| D ] \}}d|jd i|| |< q"qt|S )a
Returns a map of tag names to run information.
Args:
mapping: the result of DataProvider's `list_blob_sequences`.
Returns:
A nested map from run strings to tag string to image info, where image
info is an object of form {"maxSamplesPerStep": num}. For example,
{
"reshaped": {
"test": {"maxSamplesPerStep": 1},
"train": {"maxSamplesPerStep": 1}
},
"convolved": {"test": {"maxSamplesPerStep": 50}},
}
ZmaxSamplesPerStepr- )r
r dictr
max_length)r Ztag_run_image_infor r r r r r r _get_tag_run_image_info s
r: c C s t | t| dS )aV Prepares an image mapping for client consumption.
Args:
mapping: the result of DataProvider's `list_blob_sequences`.
Returns:
A dict with the following fields:
tagRunSampledInfo: the return type of `_get_tag_run_image_info`
tagDescriptions: the return type of `_get_tag_description_info`
)r+ ZtagRunSampledInfo)r% r: r( r r r _format_image_mapping s r; c @ s e Zd ZdZejZdd Zdd Zdd Z dd Z
d
d Z e j
jd d
Zd)ddZdd Ze j
jdd Zdd Zdd Zdd Zdd Zd d Zd d Zd!d" Zd#d$ Ze j
jd%d& Zd'd( Z dS )*
MetricsPluginz Metrics Plugin for TensorBoard.c C sr |j | _|jpi }|tjd|tjd|tjdd| _t j
ddd| _ t j
ddd| _ t j
d dd| _
d
S ) zInstantiates MetricsPlugin.
Args:
context: A base_plugin.TBContext instance. MetricsLoader checks that
it contains a valid `data_provider`.
i 3
)scalars
histogramsimageszscalar time seriesr )Z data_kindZlatest_known_versionzhistogram time serieszimage time seriesN)Z
data_provider_data_providersampling_hintsgetscalar_metadata PLUGIN_NAMEhistogram_metadataimage_metadata_plugin_downsamplingr Z_MetadataVersionChecker_scalar_version_checker_histogram_version_checker_image_version_checker)selfcontextrC r r r __init__ s*
zMetricsPlugin.__init__c C s t jdddS )NTz Time Series)Zis_ng_componentZtab_name)r ZFrontendMetadatarM r r r frontend_metadata s z MetricsPlugin.frontend_metadatac C s | j | j| jdS )N)z/tagsz /timeSeriesz
/imageData) _serve_tags_serve_time_series_serve_image_datarP r r r get_plugin_apps s z MetricsPlugin.get_plugin_appsc C s t jtjtjfS )N)rE rF rG rH rP r r r data_plugin_names& s z MetricsPlugin.data_plugin_namesc C s dS )NFr rP r r r is_active- s zMetricsPlugin.is_activec C s4 t |j}t |j}| j||d}t||dS )N)
experimentapplication/json)r rN environ
experiment_id
_tags_implr Respond)rM requestctxrX r5 r r r rR 0 s zMetricsPlugin._serve_tagsNc C s | j j||tjd}| |tj| j}| j j||tjd}|dkrFi }| |tj| j }| j j
||t jd}|dkrxi }| |t j| j }i }t
||d< t
||d< t||d< |S )a Returns tag metadata for a given experiment's logged metrics.
Args:
ctx: A `tensorboard.context.RequestContext` value.
experiment: optional string ID of the request's experiment.
Returns:
A nested dict 'd' with keys in ("scalars", "histograms", "images")
and values being the return type of _format_*mapping.
)r[ plugin_nameNr? r@ rA )rB Z list_scalarsrE rF _filter_by_versionZparse_plugin_metadatarJ Z list_tensorsrG rK Zlist_blob_sequencesrH rL r, r; )rM r_ rX Zscalar_mappingZhistogram_mappingZ
image_mappingr$ r r r r\ 7 sN zMetricsPlugin._tags_implc
C s^ dd |D }| D ]B\}}| D ]0\}}||j} || j||sJq&||| |< q&q|S )z@Filter `DataProvider.list_*` output by summary metadata version.c S s i | ]
}|i qS r r r& r r r r) o s z4MetricsPlugin._filter_by_version..)r
Zplugin_contentokversion)
rM r Zparse_metadataZversion_checkerr$ r r r r Zmdr r r ra m s
z MetricsPlugin._filter_by_versionc C s t |j}t |j}|jdkr0|jd}n |jd}|sJt dzt
|}W n t k
rv t dY nX |
|||}t||dS )NPOSTrequestszMissing 'requests' fieldz"Unable to parse 'requests' as JSONrY )r rN rZ r[ methodformrD argsr InvalidArgumentErrorjsonloads
ValueError_time_series_implr r] )rM r^ r_ rX Zseries_requests_stringseries_requestsresponser r r rS x s
z MetricsPlugin._serve_time_seriesc s fdd|D }|S )a~ Constructs a list of responses from a list of series requests.
Args:
ctx: A `tensorboard.context.RequestContext` value.
experiment: string ID of the request's experiment.
series_requests: a list of `TimeSeriesRequest` dicts (see http_api.md).
Returns:
A list of `TimeSeriesResponse` dicts (see http_api.md).
c s g | ]} |qS r )_get_time_series)r' r^ r_ rX rM r r
s z3MetricsPlugin._time_series_impl..r )rM r_ rX rn responsesr rq r rm s z MetricsPlugin._time_series_implc C sZ | d}| d}| d}| d}||d}t|trD||d< t|trV||d< |S )Nr r pluginr4 )rt r )rD
isinstancestrint)rM series_requestr r rt r4 ro r r r _create_base_response s
z#MetricsPlugin._create_base_responsec C s | d}| d}| d}| d}t|ts6dS |tjkrX|tjkrX|tjkrXdS |tkrnt|tsndS |tkrt|t sdS d S ) Nr rt r r4 z Missing tagzInvalid pluginz Missing runzMissing sample)
rD ru rv rE rF rG rH _SINGLE_RUN_PLUGINS_SAMPLED_PLUGINSrw )rM rx r rt r r4 r r r _get_invalid_request_error s$
z(MetricsPlugin._get_invalid_request_errorc C s | d}| d}| d}| d}| |}| |} | rL| |d< |S |rV|gnd}
d} |tjkrx| ||||
} |tjkr| ||||
} |tjkr| |||||
} | |d< |S )aY Returns time series data for a given tag, plugin.
Args:
ctx: A `tensorboard.context.RequestContext` value.
experiment: string ID of the request's experiment.
series_request: a `TimeSeriesRequest` (see http_api.md).
Returns:
A `TimeSeriesResponse` dict (see http_api.md).
r r rt r4 errorNZ runToSeries)
rD ry r| rE rF _get_run_to_scalar_seriesrG _get_run_to_histogram_seriesrH _get_run_to_image_series) rM r_ rX rx r r rt r4 ro Z
request_errorr
run_to_seriesr r r rp sF
z MetricsPlugin._get_time_seriesc
C sh | j j||tj| jd tj||gdd}i }| D ],\}}||krHq6dd || D } | ||< q6|S )a Builds a run-to-scalar-series dict for client consumption.
Args:
ctx: A `tensorboard.context.RequestContext` value.
experiment: a string experiment id.
tag: string of the requested tag.
runs: optional list of run names as strings.
Returns:
A map from string run names to `ScalarStepDatum` (see http_api.md).
r? r tagsr[ r` Z
downsampleZrun_tag_filterc S s g | ]}|j |j|jd qS ))r/ r. value)r2 r. r r' r6 r r r rr s
z;MetricsPlugin._get_run_to_scalar_series..)rB Z read_scalarsrE rF rI r RunTagFilterr
rM r_ rX r r r r
result_runtag_datar1 r r r r~ s
z'MetricsPlugin._get_run_to_scalar_seriesc C s |j }dd |D }|S )zFormats a histogram datum's bins for client consumption.
Args:
datum: a DataProvider's TensorDatum.
Returns:
A list of `HistogramBin`s (see http_api.md).
c S s$ g | ] }|d |d |d dqS )r r r- )minmaxcountr )r' xr r r rr s z>MetricsPlugin._format_histogram_datum_bins..)Znumpytolist)rM r6 Z
numpy_listbinsr r r _format_histogram_datum_bins s
z*MetricsPlugin._format_histogram_datum_binsc
sl j j||tj jd tj||gdd}i }| D ]0\}}||krHq6 fdd|| D } | ||< q6|S )a Builds a run-to-histogram-series dict for client consumption.
Args:
ctx: A `tensorboard.context.RequestContext` value.
experiment: a string experiment id.
tag: string of the requested tag.
runs: optional list of run names as strings.
Returns:
A map from string run names to `HistogramStepDatum` (see http_api.md).
r@ r r c s" g | ]}|j |j |d qS ))r/ r. r )r2 r. r r rP r r rr 4 s
z>MetricsPlugin._get_run_to_histogram_series..)rB Z read_tensorsrG rF rI r r r
r r rP r r s
z*MetricsPlugin._get_run_to_histogram_seriesc C sl | j j||tj| jd tj||gdd}i }| D ]0\}} || krHq6| | }
t|
|} | r6| ||< q6|S )a Builds a run-to-image-series dict for client consumption.
Args:
ctx: A `tensorboard.context.RequestContext` value.
experiment: a string experiment id.
tag: string of the requested tag.
sample: zero-indexed integer for the requested sample.
runs: optional list of run names as strings.
Returns:
A `RunToSeries` dict (see http_api.md).
rA )r r ) rB Zread_blob_sequencesrH rF rI r r r
r7 ) rM r_ rX r r4 r r r r r Zblob_sequence_datum_listZseriesr r r r @ s&
z&MetricsPlugin._get_run_to_image_seriesc C sB t |j}|jd }|s$td| ||\}}t|||S )zServes an individual image.r0 zMissing 'imageId' field) r rN rZ rh r ri _image_data_implr r] )rM r^ r_ r3 data content_typer r r rT b s
z MetricsPlugin._serve_image_datac C s0 | j j||d}td|}t|t}||fS )ao Gets the image data for a blob key.
Args:
ctx: A `tensorboard.context.RequestContext` value.
blob_key: a string identifier for a DataProvider blob.
Returns:
A tuple containing:
data: a raw bytestring of the requested image's contents.
content_type: a string HTTP content type.
)r3 N)rB Z read_blobimghdrwhat_IMGHDR_TO_MIMETYPErD _DEFAULT_IMAGE_MIMETYPE)rM r_ r3 r Z
image_typer r r r r m s z MetricsPlugin._image_data_impl)N) __name__
__module__ __qualname____doc__r rF r` rO rQ rU rV rW r RequestZ applicationrR r\ ra rS rm ry r| rp r~ r r r rT r r r r r r< s0 !
6
)$
$"
r< )'r r
r rj Zwerkzeugr Z tensorboardr r Ztensorboard.backendr Ztensorboard.datar Ztensorboard.pluginsr Z tensorboard.plugins.histogramr rG Ztensorboard.plugins.imagerH Ztensorboard.plugins.metricsZtensorboard.plugins.scalarrE r r frozensetrF rz r{ r r# r% r* r, r7 r: r; ZTBPluginr< r r r r sB
!