tools/telemetry/docs/pydoc/telemetry.value.html - Issue 1647513002: Delete tools/telemetry.

Unified Diff: tools/telemetry/docs/pydoc/telemetry.value.html

Issue 1647513002: Delete tools/telemetry. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master

Patch Set: Created 4 years, 11 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Download patch

« no previous file with comments | « tools/telemetry/docs/pydoc/telemetry.util.wpr_modes.html ('k') | tools/telemetry/docs/pydoc/telemetry.value.failure.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: tools/telemetry/docs/pydoc/telemetry.value.html

diff --git a/tools/telemetry/docs/pydoc/telemetry.value.html b/tools/telemetry/docs/pydoc/telemetry.value.html

deleted file mode 100644

index 8d397fdf9c7bbab277fa4b106ecc3cecd7492623..0000000000000000000000000000000000000000

--- a/tools/telemetry/docs/pydoc/telemetry.value.html

+++ /dev/null

@@ -1,235 +0,0 @@

-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

-<html><head><title>Python: package telemetry.value</title>

-<meta charset="utf-8">

-</head><body bgcolor="#f0f0f8">

-<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">

-<tr bgcolor="#7799ee">

-<td valign=bottom>

-  <big><big><a href="telemetry.html">telemetry</a>.value</big></big></td

-><td align=right valign=bottom

-><a href=".">index</a> <a href="../telemetry/value/__init__.py">telemetry/value/__init__.py</a></td></tr></table>

- <tt>The <a href="#Value">Value</a> hierarchy provides a way of representing the values measurements

-produce such that they can be merged across runs, grouped by page, and output

-to different targets.

-

-The core <a href="#Value">Value</a> concept provides the basic functionality:

-- association with a page, may be none

-- naming and units

-- importance tracking [whether a value will show up on a waterfall or output

-  file by default]

-- other metadata, such as a description of what was measured

-- default conversion to scalar and string

-- merging properties

-

-A page may actually run a few times during a single telemetry session.

-Downstream consumers of test results typically want to group these runs

-together, then compute summary statistics across runs. <a href="#Value">Value</a> provides the

-Merge* family of methods for this kind of aggregation.</tt>

-

-<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

-<tr bgcolor="#aa55cc">

-<td colspan=3 valign=bottom>

-<big>Package Contents</big></td></tr>

-<tr><td bgcolor="#aa55cc"><tt>      </tt></td><td> </td>

-<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.value.failure.html">failure</a>

-<a href="telemetry.value.failure_unittest.html">failure_unittest</a>

-<a href="telemetry.value.histogram.html">histogram</a>

-<a href="telemetry.value.histogram_unittest.html">histogram_unittest</a>

-<a href="telemetry.value.histogram_util.html">histogram_util</a>

-<a href="telemetry.value.histogram_util_unittest.html">histogram_util_unittest</a>

-<a href="telemetry.value.improvement_direction.html">improvement_direction</a>

-</td><td width="25%" valign=top><a href="telemetry.value.list_of_scalar_values.html">list_of_scalar_values</a>

-<a href="telemetry.value.list_of_scalar_values_unittest.html">list_of_scalar_values_unittest</a>

-<a href="telemetry.value.list_of_string_values.html">list_of_string_values</a>

-<a href="telemetry.value.list_of_string_values_unittest.html">list_of_string_values_unittest</a>

-<a href="telemetry.value.merge_values.html">merge_values</a>

-<a href="telemetry.value.merge_values_unittest.html">merge_values_unittest</a>

-<a href="telemetry.value.none_values.html">none_values</a>

-</td><td width="25%" valign=top><a href="telemetry.value.scalar.html">scalar</a>

-<a href="telemetry.value.scalar_unittest.html">scalar_unittest</a>

-<a href="telemetry.value.skip.html">skip</a>

-<a href="telemetry.value.skip_unittest.html">skip_unittest</a>

-<a href="telemetry.value.string.html">string</a>

-<a href="telemetry.value.string_unittest.html">string_unittest</a>

-<a href="telemetry.value.summarizable.html">summarizable</a>

-</td><td width="25%" valign=top><a href="telemetry.value.summary.html">summary</a>

-<a href="telemetry.value.summary_unittest.html">summary_unittest</a>

-<a href="telemetry.value.trace.html">trace</a>

-<a href="telemetry.value.trace_unittest.html">trace_unittest</a>

-<a href="telemetry.value.value_unittest.html">value_unittest</a>

-</td></tr></table></td></tr></table>

-<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

-<tr bgcolor="#ee77aa">

-<td colspan=3 valign=bottom>

-<big>Classes</big></td></tr>

-<tr><td bgcolor="#ee77aa"><tt>      </tt></td><td> </td>

-<td width="100%"><dl>

-<dt><a href="__builtin__.html#object">__builtin__.object</a>

-</dt><dd>

-<dl>

-<dt><a href="telemetry.value.html#Value">Value</a>

-</dt></dl>

-</dd>

-</dl>

-

-<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

-<tr bgcolor="#ffc8d8">

-<td colspan=3 valign=bottom>

-<a name="Value">class Value</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</td></tr>

-<tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>

-<td colspan=2><tt>An abstract value produced by a telemetry page test.  </tt></td></tr>

-<tr><td> </td>

-<td width="100%">Methods defined here:

-<dl><dt><a name="Value-AsDict">AsDict</a>(self)</dt><dd><tt>Pre-serializes a value to a dict for output as JSON.</tt></dd></dl>

-<dl><dt><a name="Value-AsDictWithoutBaseClassEntries">AsDictWithoutBaseClassEntries</a>(self)</dt></dl>

-<dl><dt><a name="Value-GetBuildbotDataType">GetBuildbotDataType</a>(self, output_context)</dt><dd><tt>Returns the buildbot's equivalent data_type.

-

-This should be one of the values accepted by perf_tests_results_helper.py.</tt></dd></dl>

-<dl><dt><a name="Value-GetBuildbotValue">GetBuildbotValue</a>(self)</dt><dd><tt>Returns the buildbot's equivalent value.</tt></dd></dl>

-<dl><dt><a name="Value-GetChartAndTraceNameForComputedSummaryResult">GetChartAndTraceNameForComputedSummaryResult</a>(self, trace_tag)</dt></dl>

-<dl><dt><a name="Value-GetChartAndTraceNameForPerPageResult">GetChartAndTraceNameForPerPageResult</a>(self)</dt></dl>

-<dl><dt><a name="Value-GetRepresentativeNumber">GetRepresentativeNumber</a>(self)</dt><dd><tt>Gets a single scalar value that best-represents this value.

-

-Returns None if not possible.</tt></dd></dl>

-<dl><dt><a name="Value-GetRepresentativeString">GetRepresentativeString</a>(self)</dt><dd><tt>Gets a string value that best-represents this value.

-

-Returns None if not possible.</tt></dd></dl>

-<dl><dt><a name="Value-IsMergableWith">IsMergableWith</a>(self, that)</dt></dl>

-<dl><dt><a name="Value-__eq__">__eq__</a>(self, other)</dt></dl>

-<dl><dt><a name="Value-__hash__">__hash__</a>(self)</dt></dl>

-<dl><dt><a name="Value-__init__">__init__</a>(self, page, name, units, important, description, tir_label)</dt><dd><tt>A generic <a href="#Value">Value</a> <a href="__builtin__.html#object">object</a>.

-

-Args:

-  page: A Page <a href="__builtin__.html#object">object</a>, may be given as None to indicate that the value

-      represents results for multiple pages.

-  name: A value name string, may contain a dot. Values from the same test

-      with the same prefix before the dot may be considered to belong to

-      the same chart.

-  units: A units string.

-  important: Whether the value is "important". Causes the value to appear

-      by default in downstream UIs.

-  description: A string explaining in human-understandable terms what this

-      value represents.

-  tir_label: The string label of the TimelineInteractionRecord with

-      which this value is associated.</tt></dd></dl>

-<hr>

-Class methods defined here:

-<dl><dt><a name="Value-MergeLikeValuesFromDifferentPages">MergeLikeValuesFromDifferentPages</a>(cls, values) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Combines the provided values into a single compound value.

-

-When a full pageset runs, a single value_name will usually end up getting

-collected for multiple pages. For instance, we may end up with

-   [ScalarValue(page1, 'a',  1),

-    ScalarValue(page2, 'a',  2)]

-

-This function takes in the values of the same name, but across multiple

-pages, and produces a single summary result value. In this instance, it

-could produce a ScalarValue(None, 'a', 1.5) to indicate averaging, or even

-ListOfScalarValues(None, 'a', [1, 2]) if concatenated output was desired.

-

-Some results are so specific to a page that they make no sense when

-aggregated across pages. If merging values of this type across pages is

-non-sensical, this method may return None.</tt></dd></dl>

-<dl><dt><a name="Value-MergeLikeValuesFromSamePage">MergeLikeValuesFromSamePage</a>(cls, values) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Combines the provided list of values into a single compound value.

-

-When a page runs multiple times, it may produce multiple values. This

-function is given the same-named values across the multiple runs, and has

-the responsibility of producing a single result.

-

-It must return a single <a href="#Value">Value</a>. If merging does not make sense, the

-implementation must pick a representative value from one of the runs.

-

-For instance, it may be given

-    [ScalarValue(page, 'a', 1), ScalarValue(page, 'a', 2)]

-and it might produce

-    ListOfScalarValues(page, 'a', [1, 2])</tt></dd></dl>

-<hr>

-Static methods defined here:

-<dl><dt><a name="Value-FromDict">FromDict</a>(value_dict, page_dict)</dt><dd><tt>Produces a value from a value dict and a page dict.

-

-<a href="#Value">Value</a> dicts are produced by serialization to JSON, and must be accompanied

-by a dict mapping page IDs to pages, also produced by serialization, in

-order to be completely deserialized. If deserializing multiple values, use

-ListOfValuesFromListOfDicts instead.

-

-value_dict: a dictionary produced by <a href="#Value-AsDict">AsDict</a>() on a value subclass.

-page_dict: a dictionary mapping IDs to page objects.</tt></dd></dl>

-<dl><dt><a name="Value-GetConstructorKwArgs">GetConstructorKwArgs</a>(value_dict, page_dict)</dt><dd><tt>Produces constructor arguments from a value dict and a page dict.

-

-Takes a dict parsed from JSON and an index of pages and recovers the

-keyword arguments to be passed to the constructor for deserializing the

-dict.

-

-value_dict: a dictionary produced by <a href="#Value-AsDict">AsDict</a>() on a value subclass.

-page_dict: a dictionary mapping IDs to page objects.</tt></dd></dl>

-<dl><dt><a name="Value-GetJSONTypeName">GetJSONTypeName</a>()</dt><dd><tt>Gets the typename for serialization to JSON using AsDict.</tt></dd></dl>

-<dl><dt><a name="Value-ListOfValuesFromListOfDicts">ListOfValuesFromListOfDicts</a>(value_dicts, page_dict)</dt><dd><tt>Takes a list of value dicts to values.

-

-Given a list of value dicts produced by AsDict, this method

-deserializes the dicts given a dict mapping page IDs to pages.

-This method performs memoization for deserializing a list of values

-efficiently, where FromDict is meant to handle one-offs.

-

-values: a list of value dicts produced by <a href="#Value-AsDict">AsDict</a>() on a value subclass.

-page_dict: a dictionary mapping IDs to page objects.</tt></dd></dl>

-<hr>

-Data descriptors defined here:

-<dl><dt>__dict__</dt>

-<dd><tt>dictionary for instance variables (if defined)</tt></dd>

-</dl>

-<dl><dt>__weakref__</dt>

-<dd><tt>list of weak references to the object (if defined)</tt></dd>

-</dl>

-<dl><dt>name_suffix</dt>

-<dd><tt>Returns the string after a . in the name, or the full name otherwise.</tt></dd>

-</dl>

-</td></tr></table></td></tr></table>

-<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

-<tr bgcolor="#eeaa77">

-<td colspan=3 valign=bottom>

-<big>Functions</big></td></tr>

-<tr><td bgcolor="#eeaa77"><tt>      </tt></td><td> </td>

-<td width="100%"><dl><dt><a name="-ValueNameFromTraceAndChartName">ValueNameFromTraceAndChartName</a>(trace_name, chart_name=None)</dt><dd><tt>Mangles a trace name plus optional chart name into a standard string.

-

-A value might just be a bareword name, e.g. numPixels. In that case, its

-chart may be None.

-

-But, a value might also be intended for display with other values, in which

-case the chart name indicates that grouping. So, you might have

-screen.numPixels, screen.resolution, where chartName='screen'.</tt></dd></dl>

-</td></tr></table>

-<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

-<tr bgcolor="#55aa55">

-<td colspan=3 valign=bottom>

-<big>Data</big></td></tr>

-<tr><td bgcolor="#55aa55"><tt>      </tt></td><td> </td>

-<td width="100%">COMPUTED_PER_PAGE_SUMMARY_OUTPUT_CONTEXT = 'merged-pages-result-output-context'

-CONCATENATE = 'concatenate'

-PER_PAGE_RESULT_OUTPUT_CONTEXT = 'per-page-result-output-context'

-PICK_FIRST = 'pick-first'

-SUMMARY_RESULT_OUTPUT_CONTEXT = 'summary-result-output-context'</td></tr></table>

-</body></html>