o
i eoW @ 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)bmpgifjpegpngsvgzapplication/octet-streamc C sj t t}t t}| D ]"\}}| D ]\}}|j}t|r/|| | || | qq||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 Y/var/www/myenv/lib/python3.10/site-packages/tensorboard/plugins/metrics/metrics_plugin.py_get_tag_description_info4 s
r c C sl g }| D ](}t || }t|dkrdnd}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 prefixed_descriptionsr r run_or_runs
run_headerdescription_htmlheaderr r r _build_combined_descriptionN s r+ c C sX t | \}}i }|D ] }t|| }t|dkr |d }nt||}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 markdown_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 r1 r r1 r _get_run_tag_info s r3 c C 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`
)
runTagInfotagDescriptions)r3 r. r1 r r r _format_basic_mapping s
r7 c C sH |d }g }| D ]}t |j|krq||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$ r9 wall_timeblob_key)sorted_datum_listsampleindex step_datadatumr r r !_format_image_blob_sequence_datum s
rD c C sL t t}| D ]\}}| D ]\}}d|jd i|| |< qq t|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}},
}
maxSamplesPerStepr8 )r r dictr
max_length)r tag_run_image_infor r r r r r r _get_tag_run_image_info s
rI c C r4 )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`
)r6 tagRunSampledInfo)r. rI r1 r r r _format_image_mapping s rK 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 ) data_kindlatest_known_versionzhistogram time serieszimage time seriesN)
data_provider_data_providersampling_hintsgetscalar_metadata PLUGIN_NAMEhistogram_metadataimage_metadata_plugin_downsamplingr _MetadataVersionChecker_scalar_version_checker_histogram_version_checker_image_version_checker)selfcontextrV r r r __init__ s(
zMetricsPlugin.__init__c C s t jdddS )NTz Time Series)is_ng_componenttab_name)r FrontendMetadatara 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_datarg r r r get_plugin_apps s z MetricsPlugin.get_plugin_appsc C s t jtjtjfS N)rX rY rZ r[ rg r r r data_plugin_names& s z MetricsPlugin.data_plugin_namesc C s dS )NFr rg r r r is_active- s zMetricsPlugin.is_activec C s4 t |j}t |j}| j||d}t||dS )N)
experimentapplication/json)r rb environ
experiment_id
_tags_implr Respond)ra requestctxrp rA r r r ri 0 s zMetricsPlugin._serve_tagsNc C s | j j||tjd}| |tj| j}| j j||tjd}|du r#i }| |tj| j }| j j
||t jd}|du r.)r plugin_contentokversion)
ra r parse_metadataversion_checkerr- r r r r mdr r r rz m s
z MetricsPlugin._filter_by_versionc C s t |j}t |j}|jdkr|jd}n|jd}|s%t dzt
|}W n t y8 t dw |
|||}t||dS )NPOSTrequestszMissing 'requests' fieldz"Unable to parse 'requests' as JSONrq )r rb rr rs methodformrW argsr InvalidArgumentErrorjsonloads
ValueError_time_series_implr ru )ra rv rw rp series_requests_stringseries_requestsresponser r r rj 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)r0 rv rw rp ra r r
s z3MetricsPlugin._time_series_impl..r )ra rw rp r responsesr r r r s z MetricsPlugin._time_series_implc C sZ | d}| d}| d}| d}||d}t|tr"||d< t|tr+||d< |S )Nr r pluginr@ )r r )rW
isinstancestrint)ra series_requestr r r r@ r r r r _create_base_response s
z#MetricsPlugin._create_base_responsec C s | d}| d}| d}| d}t|tsdS |tjkr,|tjkr,|tjkr,dS |tv r7t|ts7dS |tv rBt|t sBdS d S ) Nr r r r@ z Missing tagzInvalid pluginz Missing runzMissing sample)
rW r r rX rY rZ r[ _SINGLE_RUN_PLUGINS_SAMPLED_PLUGINSr )ra r r r r r@ r r r _get_invalid_request_error s
z(MetricsPlugin._get_invalid_request_errorc C s | d}| d}| d}| d}| |}| |} | r&| |d< |S |r+|gnd}
d} |tjkr<| ||||
} |tjkrI| ||||
} |tjkrW| |||||
} | |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 r r@ errorN runToSeries)
rW r r rX rY _get_run_to_scalar_seriesrZ _get_run_to_histogram_seriesr[ _get_run_to_image_series) ra rw rp r r r r r@ r
request_errorr
run_to_seriesr r r r s2
z MetricsPlugin._get_time_seriesc
C sh | j j||tj| jd tj||gdd}i }| D ]\}}||vr$qdd || D } | ||< q|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).
rO r tagsrs rx
downsamplerun_tag_filterc S s g | ] }|j |j|jd qS ))r: r9 value)r= r9 r r0 rC r r r r s z;MetricsPlugin._get_run_to_scalar_series..)rU read_scalarsrX rY r\ r RunTagFilterr
ra rw rp r r r r
result_runtag_datar< 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 r8 )minmaxcountr )r0 xr r r r s $ z>MetricsPlugin._format_histogram_datum_bins..)numpytolist)ra rC
numpy_listbinsr r r _format_histogram_datum_bins s
z*MetricsPlugin._format_histogram_datum_binsc
sl j j||tj jd tj||gdd}i }| D ]\}}||vr$q fdd|| D } | ||< q|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).
rP r r c s" g | ]
}|j |j |d qS ))r: r9 r )r= r9 r r rg r r r 4 s z>MetricsPlugin._get_run_to_histogram_series..)rU read_tensorsrZ rY r\ r r r r r rg r r s
z*MetricsPlugin._get_run_to_histogram_seriesc C sl | j j||tj| jd tj||gdd}i }| D ]\}} || vr$q| | }
t|
|} | r3| ||< q|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).
rQ )r r ) rU read_blob_sequencesr[ rY r\ r r r rD ) ra rw rp r r@ r r r r r blob_sequence_datum_listseriesr r r r @ s&
z&MetricsPlugin._get_run_to_image_seriesc C sB t |j}|jd }|std| ||\}}t|||S )zServes an individual image.r; zMissing 'imageId' field) r rb rr r r r _image_data_implr ru )ra rv rw r> data content_typer r r rk 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.
)r> N)rU read_blobimghdrwhat_IMGHDR_TO_MIMETYPErW _DEFAULT_IMAGE_MIMETYPE)ra rw r> r
image_typer r r r r m s z MetricsPlugin._image_data_implrm ) __name__
__module__ __qualname____doc__r rY rx rc rh rl rn ro r Request applicationri rt rz rj r r r r r r r r rk r r r r r rL s2 !
6
)$
$"
rL )'r r r r werkzeugr tensorboardr r tensorboard.backendr tensorboard.datar tensorboard.pluginsr tensorboard.plugins.histogramr rZ tensorboard.plugins.imager[ tensorboard.plugins.metricstensorboard.plugins.scalarrX r r frozensetrY r r r r+ r. r3 r7 rD rI rK TBPluginrL r r r r sD
!