Startseite Erkunden Hilfe
Anmelden
cnheider
/
draugr
Mirror von https://github.com/cnheider/draugr
Beobachten 1
Favorit hinzufügen 1
Fork 0
Dateien Issues 0 Wiki
Branch: master
Branches Tags
draugr
/
docs
/
github
/
html
/
generated
/
draugr.metrics.metric_collection.MetricCollection.html

draugr.metrics.metric_collection.MetricCollection.html 32 KB
Permalink Verlauf Originalformat

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399 
  1. 

  2. <!DOCTYPE html>
    3. 

  3. 

  4. <html lang="en">
    5. 

  5.   <head>
    6. 

  6.     <meta charset="utf-8" />
    7. 

  7.     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
    8. 

  8. 

  9.     <title>draugr.metrics.metric_collection.MetricCollection &#8212; Draugr 1.0.1 documentation</title>
    10. 

  10.     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    11. 

  11.     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
    12. 

  12.     <link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
    13. 

  13.     <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
    14. 

  14.     <script src="../_static/jquery.js"></script>
    15. 

  15.     <script src="../_static/underscore.js"></script>
    16. 

  16.     <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
    17. 

  17.     <script src="../_static/doctools.js"></script>
    18. 

  18.     <link rel="canonical" href="pything.github.io/draugr/generated/draugr.metrics.metric_collection.MetricCollection.html" />
    19. 

  19.     <link rel="index" title="Index" href="../genindex.html" />
    20. 

  20.     <link rel="search" title="Search" href="../search.html" />
    21. 

  21.     <link rel="next" title="draugr.metrics.metric_summary" href="draugr.metrics.metric_summary.html" />
    22. 

  22.     <link rel="prev" title="draugr.metrics.metric_collection" href="draugr.metrics.metric_collection.html" />
    23. 

  23.    
    24. 

  24.   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
    25. 

  25.   
    26. 

  26.   
    27. 

  27.   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
    28. 

  28. 

  29.   </head><body>
    30. 

  30.   
    31. 

  31. 

  32.     <div class="document">
    33. 

  33.       <div class="documentwrapper">
    34. 

  34.         <div class="bodywrapper">
    35. 

  35.           
    36. 

  36. 

  37.           <div class="body" role="main">
    38. 

  38.             
    39. 

  39.   <section id="draugr-metrics-metric-collection-metriccollection">
    40. 

  40. <h1>draugr.metrics.metric_collection.MetricCollection<a class="headerlink" href="#draugr-metrics-metric-collection-metriccollection" title="Permalink to this heading">¶</a></h1>
    41. 

  41. <dl class="py class">
    42. 

  42. <dt class="sig sig-object py" id="draugr.metrics.metric_collection.MetricCollection">
    43. 

  43. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">draugr.metrics.metric_collection.</span></span><span class="sig-name descname"><span class="pre">MetricCollection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">metrics</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('signal',</span> <span class="pre">'length')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">measures</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">['StatisticsError',</span> <span class="pre">'fmean',</span> <span class="pre">'geometric_mean',</span> <span class="pre">'harmonic_mean',</span> <span class="pre">'mean',</span> <span class="pre">'median',</span> <span class="pre">'median_grouped',</span> <span class="pre">'median_high',</span> <span class="pre">'median_low',</span> <span class="pre">'mode',</span> <span class="pre">'multimode',</span> <span class="pre">'pstdev',</span> <span class="pre">'pvariance',</span> <span class="pre">'quantiles',</span> <span class="pre">'stdev',</span> <span class="pre">'variance']</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keep_measure_history</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_disk_cache</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/draugr/metrics/metric_collection.html#MetricCollection"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#draugr.metrics.metric_collection.MetricCollection" title="Permalink to this definition">¶</a></dt>
    44. 

  44. <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p>
    45. 

  45. <p>description</p>
    46. 

  46. <dl class="py method">
    47. 

  47. <dt class="sig sig-object py" id="draugr.metrics.metric_collection.MetricCollection.__init__">
    48. 

  48. <span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">metrics</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('signal',</span> <span class="pre">'length')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">measures</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">['StatisticsError',</span> <span class="pre">'fmean',</span> <span class="pre">'geometric_mean',</span> <span class="pre">'harmonic_mean',</span> <span class="pre">'mean',</span> <span class="pre">'median',</span> <span class="pre">'median_grouped',</span> <span class="pre">'median_high',</span> <span class="pre">'median_low',</span> <span class="pre">'mode',</span> <span class="pre">'multimode',</span> <span class="pre">'pstdev',</span> <span class="pre">'pvariance',</span> <span class="pre">'quantiles',</span> <span class="pre">'stdev',</span> <span class="pre">'variance']</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keep_measure_history</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_disk_cache</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/draugr/metrics/metric_collection.html#MetricCollection.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#draugr.metrics.metric_collection.MetricCollection.__init__" title="Permalink to this definition">¶</a></dt>
    49. 

  49. <dd></dd></dl>
    50. 

  50. 

  51. <p class="rubric">Methods</p>
    52. 

  52. <table class="autosummary longtable docutils align-default">
    53. 

  53. <colgroup>
    54. 

  54. <col style="width: 10%" />
    55. 

  55. <col style="width: 90%" />
    56. 

  56. </colgroup>
    57. 

  57. <tbody>
    58. 

  58. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.metrics.metric_collection.MetricCollection.__init__" title="draugr.metrics.metric_collection.MetricCollection.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code></a>([metrics, measures, ...])</p></td>
    59. 

  59. <td><p></p></td>
    60. 

  60. </tr>
    61. 

  61. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.metrics.metric_collection.MetricCollection.add_metric" title="draugr.metrics.metric_collection.MetricCollection.add_metric"><code class="xref py py-obj docutils literal notranslate"><span class="pre">add_metric</span></code></a>(name)</p></td>
    62. 

  62. <td><p><dl class="field-list simple">
    63. 

  63. <dt class="field-odd">param name</dt>
    64. 

  64. <dd class="field-odd"><p></p></dd>
    65. 

  65. </dl>
    66. 

  66. </p></td>
    67. 

  67. </tr>
    68. 

  68. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.metrics.metric_collection.MetricCollection.append" title="draugr.metrics.metric_collection.MetricCollection.append"><code class="xref py py-obj docutils literal notranslate"><span class="pre">append</span></code></a>(*args, **kwargs)</p></td>
    69. 

  69. <td><p><dl class="field-list simple">
    70. 

  70. <dt class="field-odd">param args</dt>
    71. 

  71. <dd class="field-odd"><p></p></dd>
    72. 

  72. </dl>
    73. 

  73. </p></td>
    74. 

  74. </tr>
    75. 

  75. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.metrics.metric_collection.MetricCollection.clear" title="draugr.metrics.metric_collection.MetricCollection.clear"><code class="xref py py-obj docutils literal notranslate"><span class="pre">clear</span></code></a>()</p></td>
    76. 

  76. <td><p></p></td>
    77. 

  77. </tr>
    78. 

  78. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.metrics.metric_collection.MetricCollection.copy" title="draugr.metrics.metric_collection.MetricCollection.copy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">copy</span></code></a>()</p></td>
    79. 

  79. <td><p></p></td>
    80. 

  80. </tr>
    81. 

  81. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.metrics.metric_collection.MetricCollection.fromkeys" title="draugr.metrics.metric_collection.MetricCollection.fromkeys"><code class="xref py py-obj docutils literal notranslate"><span class="pre">fromkeys</span></code></a>([value])</p></td>
    82. 

  82. <td><p>Create a new dictionary with keys from iterable and values set to value.</p></td>
    83. 

  83. </tr>
    84. 

  84. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.metrics.metric_collection.MetricCollection.get" title="draugr.metrics.metric_collection.MetricCollection.get"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get</span></code></a>(key[, default])</p></td>
    85. 

  85. <td><p>Return the value for key if key is in the dictionary, else default.</p></td>
    86. 

  86. </tr>
    87. 

  87. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.metrics.metric_collection.MetricCollection.items" title="draugr.metrics.metric_collection.MetricCollection.items"><code class="xref py py-obj docutils literal notranslate"><span class="pre">items</span></code></a>()</p></td>
    88. 

  88. <td><p><dl class="field-list simple">
    89. 

  89. <dt class="field-odd">return</dt>
    90. 

  90. <dd class="field-odd"><p></p></dd>
    91. 

  91. </dl>
    92. 

  92. </p></td>
    93. 

  93. </tr>
    94. 

  94. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.metrics.metric_collection.MetricCollection.keys" title="draugr.metrics.metric_collection.MetricCollection.keys"><code class="xref py py-obj docutils literal notranslate"><span class="pre">keys</span></code></a>()</p></td>
    95. 

  95. <td><p><dl class="field-list simple">
    96. 

  96. <dt class="field-odd">return</dt>
    97. 

  97. <dd class="field-odd"><p></p></dd>
    98. 

  98. </dl>
    99. 

  99. </p></td>
    100. 

  100. </tr>
    101. 

  101. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.metrics.metric_collection.MetricCollection.pop" title="draugr.metrics.metric_collection.MetricCollection.pop"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pop</span></code></a>(k[,d])</p></td>
    102. 

  102. <td><p>If key is not found, d is returned if given, otherwise KeyError is raised</p></td>
    103. 

  103. </tr>
    104. 

  104. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.metrics.metric_collection.MetricCollection.popitem" title="draugr.metrics.metric_collection.MetricCollection.popitem"><code class="xref py py-obj docutils literal notranslate"><span class="pre">popitem</span></code></a>()</p></td>
    105. 

  105. <td><p>Remove and return a (key, value) pair as a 2-tuple.</p></td>
    106. 

  106. </tr>
    107. 

  107. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.metrics.metric_collection.MetricCollection.remove_metric" title="draugr.metrics.metric_collection.MetricCollection.remove_metric"><code class="xref py py-obj docutils literal notranslate"><span class="pre">remove_metric</span></code></a>(name)</p></td>
    108. 

  108. <td><p><dl class="field-list simple">
    109. 

  109. <dt class="field-odd">param name</dt>
    110. 

  110. <dd class="field-odd"><p></p></dd>
    111. 

  111. </dl>
    112. 

  112. </p></td>
    113. 

  113. </tr>
    114. 

  114. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.metrics.metric_collection.MetricCollection.save" title="draugr.metrics.metric_collection.MetricCollection.save"><code class="xref py py-obj docutils literal notranslate"><span class="pre">save</span></code></a>(**kwargs)</p></td>
    115. 

  115. <td><p><dl class="field-list simple">
    116. 

  116. <dt class="field-odd">param kwargs</dt>
    117. 

  117. <dd class="field-odd"><p></p></dd>
    118. 

  118. </dl>
    119. 

  119. </p></td>
    120. 

  120. </tr>
    121. 

  121. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.metrics.metric_collection.MetricCollection.setdefault" title="draugr.metrics.metric_collection.MetricCollection.setdefault"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setdefault</span></code></a>(key[, default])</p></td>
    122. 

  122. <td><p>Insert key with a value of default if key is not in the dictionary.</p></td>
    123. 

  123. </tr>
    124. 

  124. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.metrics.metric_collection.MetricCollection.update" title="draugr.metrics.metric_collection.MetricCollection.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">update</span></code></a>([E, ]**F)</p></td>
    125. 

  125. <td><p>If E is present and has a .keys() method, then does:  for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does:  for k, v in E: D[k] = v In either case, this is followed by: for k in F:  D[k] = F[k]</p></td>
    126. 

  126. </tr>
    127. 

  127. <tr class="row-even"><td><p><a class="reference internal" href="#draugr.metrics.metric_collection.MetricCollection.values" title="draugr.metrics.metric_collection.MetricCollection.values"><code class="xref py py-obj docutils literal notranslate"><span class="pre">values</span></code></a>()</p></td>
    128. 

  128. <td><p></p></td>
    129. 

  129. </tr>
    130. 

  130. </tbody>
    131. 

  131. </table>
    132. 

  132. <p class="rubric">Attributes</p>
    133. 

  133. <table class="autosummary longtable docutils align-default">
    134. 

  134. <colgroup>
    135. 

  135. <col style="width: 10%" />
    136. 

  136. <col style="width: 90%" />
    137. 

  137. </colgroup>
    138. 

  138. <tbody>
    139. 

  139. <tr class="row-odd"><td><p><a class="reference internal" href="#draugr.metrics.metric_collection.MetricCollection.metrics" title="draugr.metrics.metric_collection.MetricCollection.metrics"><code class="xref py py-obj docutils literal notranslate"><span class="pre">metrics</span></code></a></p></td>
    140. 

  140. <td><p>return: :rtype:</p></td>
    141. 

  141. </tr>
    142. 

  142. </tbody>
    143. 

  143. </table>
    144. 

  144. <dl class="py method">
    145. 

  145. <dt class="sig sig-object py" id="draugr.metrics.metric_collection.MetricCollection.add_metric">
    146. 

  146. <span class="sig-name descname"><span class="pre">add_metric</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/draugr/metrics/metric_collection.html#MetricCollection.add_metric"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#draugr.metrics.metric_collection.MetricCollection.add_metric" title="Permalink to this definition">¶</a></dt>
    147. 

  147. <dd><dl class="field-list simple">
    148. 

  148. <dt class="field-odd">Parameters</dt>
    149. 

  149. <dd class="field-odd"><p><strong>name</strong> – </p>
    150. 

  150. </dd>
    151. 

  151. </dl>
    152. 

  152. </dd></dl>
    153. 

  153. 

  154. <dl class="py method">
    155. 

  155. <dt class="sig sig-object py" id="draugr.metrics.metric_collection.MetricCollection.append">
    156. 

  156. <span class="sig-name descname"><span class="pre">append</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/draugr/metrics/metric_collection.html#MetricCollection.append"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#draugr.metrics.metric_collection.MetricCollection.append" title="Permalink to this definition">¶</a></dt>
    157. 

  157. <dd><dl class="field-list simple">
    158. 

  158. <dt class="field-odd">Parameters</dt>
    159. 

  159. <dd class="field-odd"><ul class="simple">
    160. 

  160. <li><p><strong>args</strong> – </p></li>
    161. 

  161. <li><p><strong>kwargs</strong> – </p></li>
    162. 

  162. </ul>
    163. 

  163. </dd>
    164. 

  164. </dl>
    165. 

  165. </dd></dl>
    166. 

  166. 

  167. <dl class="py method">
    168. 

  168. <dt class="sig sig-object py" id="draugr.metrics.metric_collection.MetricCollection.clear">
    169. 

  169. <span class="sig-name descname"><span class="pre">clear</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None.</span>&#160; <span class="pre">Remove</span> <span class="pre">all</span> <span class="pre">items</span> <span class="pre">from</span> <span class="pre">D.</span></span></span><a class="headerlink" href="#draugr.metrics.metric_collection.MetricCollection.clear" title="Permalink to this definition">¶</a></dt>
    170. 

  170. <dd></dd></dl>
    171. 

  171. 

  172. <dl class="py method">
    173. 

  173. <dt class="sig sig-object py" id="draugr.metrics.metric_collection.MetricCollection.copy">
    174. 

  174. <span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">a</span> <span class="pre">shallow</span> <span class="pre">copy</span> <span class="pre">of</span> <span class="pre">D</span></span></span><a class="headerlink" href="#draugr.metrics.metric_collection.MetricCollection.copy" title="Permalink to this definition">¶</a></dt>
    175. 

  175. <dd></dd></dl>
    176. 

  176. 

  177. <dl class="py method">
    178. 

  178. <dt class="sig sig-object py" id="draugr.metrics.metric_collection.MetricCollection.fromkeys">
    179. 

  179. <span class="sig-name descname"><span class="pre">fromkeys</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#draugr.metrics.metric_collection.MetricCollection.fromkeys" title="Permalink to this definition">¶</a></dt>
    180. 

  180. <dd><p>Create a new dictionary with keys from iterable and values set to value.</p>
    181. 

  181. </dd></dl>
    182. 

  182. 

  183. <dl class="py method">
    184. 

  184. <dt class="sig sig-object py" id="draugr.metrics.metric_collection.MetricCollection.get">
    185. 

  185. <span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#draugr.metrics.metric_collection.MetricCollection.get" title="Permalink to this definition">¶</a></dt>
    186. 

  186. <dd><p>Return the value for key if key is in the dictionary, else default.</p>
    187. 

  187. </dd></dl>
    188. 

  188. 

  189. <dl class="py method">
    190. 

  190. <dt class="sig sig-object py" id="draugr.metrics.metric_collection.MetricCollection.items">
    191. 

  191. <span class="sig-name descname"><span class="pre">items</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/draugr/metrics/metric_collection.html#MetricCollection.items"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#draugr.metrics.metric_collection.MetricCollection.items" title="Permalink to this definition">¶</a></dt>
    192. 

  192. <dd><dl class="field-list simple">
    193. 

  193. <dt class="field-odd">Returns</dt>
    194. 

  194. <dd class="field-odd"><p></p>
    195. 

  195. </dd>
    196. 

  196. <dt class="field-even">Return type</dt>
    197. 

  197. <dd class="field-even"><p></p>
    198. 

  198. </dd>
    199. 

  199. </dl>
    200. 

  200. </dd></dl>
    201. 

  201. 

  202. <dl class="py method">
    203. 

  203. <dt class="sig sig-object py" id="draugr.metrics.metric_collection.MetricCollection.keys">
    204. 

  204. <span class="sig-name descname"><span class="pre">keys</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/draugr/metrics/metric_collection.html#MetricCollection.keys"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#draugr.metrics.metric_collection.MetricCollection.keys" title="Permalink to this definition">¶</a></dt>
    205. 

  205. <dd><dl class="field-list simple">
    206. 

  206. <dt class="field-odd">Returns</dt>
    207. 

  207. <dd class="field-odd"><p></p>
    208. 

  208. </dd>
    209. 

  209. <dt class="field-even">Return type</dt>
    210. 

  210. <dd class="field-even"><p></p>
    211. 

  211. </dd>
    212. 

  212. </dl>
    213. 

  213. </dd></dl>
    214. 

  214. 

  215. <dl class="py property">
    216. 

  216. <dt class="sig sig-object py" id="draugr.metrics.metric_collection.MetricCollection.metrics">
    217. 

  217. <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">metrics</span></span><a class="headerlink" href="#draugr.metrics.metric_collection.MetricCollection.metrics" title="Permalink to this definition">¶</a></dt>
    218. 

  218. <dd><p>return:
    219. 

  219. :rtype:</p>
    220. 

  220. </dd></dl>
    221. 

  221. 

  222. <dl class="py method">
    223. 

  223. <dt class="sig sig-object py" id="draugr.metrics.metric_collection.MetricCollection.pop">
    224. 

  224. <span class="sig-name descname"><span class="pre">pop</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">k</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">d</span></span></em><span class="optional">]</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">v,</span> <span class="pre">remove</span> <span class="pre">specified</span> <span class="pre">key</span> <span class="pre">and</span> <span class="pre">return</span> <span class="pre">the</span> <span class="pre">corresponding</span> <span class="pre">value.</span></span></span><a class="headerlink" href="#draugr.metrics.metric_collection.MetricCollection.pop" title="Permalink to this definition">¶</a></dt>
    225. 

  225. <dd><p>If key is not found, d is returned if given, otherwise KeyError is raised</p>
    226. 

  226. </dd></dl>
    227. 

  227. 

  228. <dl class="py method">
    229. 

  229. <dt class="sig sig-object py" id="draugr.metrics.metric_collection.MetricCollection.popitem">
    230. 

  230. <span class="sig-name descname"><span class="pre">popitem</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#draugr.metrics.metric_collection.MetricCollection.popitem" title="Permalink to this definition">¶</a></dt>
    231. 

  231. <dd><p>Remove and return a (key, value) pair as a 2-tuple.</p>
    232. 

  232. <p>Pairs are returned in LIFO (last-in, first-out) order.
    233. 

  233. Raises KeyError if the dict is empty.</p>
    234. 

  234. </dd></dl>
    235. 

  235. 

  236. <dl class="py method">
    237. 

  237. <dt class="sig sig-object py" id="draugr.metrics.metric_collection.MetricCollection.remove_metric">
    238. 

  238. <span class="sig-name descname"><span class="pre">remove_metric</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/draugr/metrics/metric_collection.html#MetricCollection.remove_metric"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#draugr.metrics.metric_collection.MetricCollection.remove_metric" title="Permalink to this definition">¶</a></dt>
    239. 

  239. <dd><dl class="field-list simple">
    240. 

  240. <dt class="field-odd">Parameters</dt>
    241. 

  241. <dd class="field-odd"><p><strong>name</strong> – </p>
    242. 

  242. </dd>
    243. 

  243. </dl>
    244. 

  244. </dd></dl>
    245. 

  245. 

  246. <dl class="py method">
    247. 

  247. <dt class="sig sig-object py" id="draugr.metrics.metric_collection.MetricCollection.save">
    248. 

  248. <span class="sig-name descname"><span class="pre">save</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/draugr/metrics/metric_collection.html#MetricCollection.save"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#draugr.metrics.metric_collection.MetricCollection.save" title="Permalink to this definition">¶</a></dt>
    249. 

  249. <dd><dl class="field-list simple">
    250. 

  250. <dt class="field-odd">Parameters</dt>
    251. 

  251. <dd class="field-odd"><p><strong>kwargs</strong> – </p>
    252. 

  252. </dd>
    253. 

  253. </dl>
    254. 

  254. </dd></dl>
    255. 

  255. 

  256. <dl class="py method">
    257. 

  257. <dt class="sig sig-object py" id="draugr.metrics.metric_collection.MetricCollection.setdefault">
    258. 

  258. <span class="sig-name descname"><span class="pre">setdefault</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#draugr.metrics.metric_collection.MetricCollection.setdefault" title="Permalink to this definition">¶</a></dt>
    259. 

  259. <dd><p>Insert key with a value of default if key is not in the dictionary.</p>
    260. 

  260. <p>Return the value for key if key is in the dictionary, else default.</p>
    261. 

  261. </dd></dl>
    262. 

  262. 

  263. <dl class="py method">
    264. 

  264. <dt class="sig sig-object py" id="draugr.metrics.metric_collection.MetricCollection.update">
    265. 

  265. <span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="n"><span class="pre">E</span></span></em>, <span class="optional">]</span><em class="sig-param"><span class="n"><span class="pre">**F</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None.</span>&#160; <span class="pre">Update</span> <span class="pre">D</span> <span class="pre">from</span> <span class="pre">dict/iterable</span> <span class="pre">E</span> <span class="pre">and</span> <span class="pre">F.</span></span></span><a class="headerlink" href="#draugr.metrics.metric_collection.MetricCollection.update" title="Permalink to this definition">¶</a></dt>
    266. 

  266. <dd><p>If E is present and has a .keys() method, then does:  for k in E: D[k] = E[k]
    267. 

  267. If E is present and lacks a .keys() method, then does:  for k, v in E: D[k] = v
    268. 

  268. In either case, this is followed by: for k in F:  D[k] = F[k]</p>
    269. 

  269. </dd></dl>
    270. 

  270. 

  271. <dl class="py method">
    272. 

  272. <dt class="sig sig-object py" id="draugr.metrics.metric_collection.MetricCollection.values">
    273. 

  273. <span class="sig-name descname"><span class="pre">values</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">an</span> <span class="pre">object</span> <span class="pre">providing</span> <span class="pre">a</span> <span class="pre">view</span> <span class="pre">on</span> <span class="pre">D's</span> <span class="pre">values</span></span></span><a class="headerlink" href="#draugr.metrics.metric_collection.MetricCollection.values" title="Permalink to this definition">¶</a></dt>
    274. 

  274. <dd></dd></dl>
    275. 

  275. 

  276. </dd></dl>
    277. 

  277. 

  278. </section>
    279. 

  279. 

  280. 

  281.           </div>
    282. 

  282.           
    283. 

  283.         </div>
    284. 

  284.       </div>
    285. 

  285.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    286. 

  286.         <div class="sphinxsidebarwrapper">
    287. 

  287.             <p class="logo"><a href="../index.html">
    288. 

  288.               <img class="logo" src="../_static/valknut.svg" alt="Logo"/>
    289. 

  289.             </a></p>
    290. 

  290. <h1 class="logo"><a href="../index.html">Draugr</a></h1>
    291. 

  291. 

  292. 

  293. 

  294. 

  295. 

  296. 

  297. 

  298. 

  299. <h3>Navigation</h3>
    300. 

  300. <ul class="current">
    301. 

  301. <li class="toctree-l1 current"><a class="reference internal" href="draugr.html">draugr</a><ul class="current">
    302. 

  302. <li class="toctree-l2"><a class="reference internal" href="draugr.dist_is_editable.html">draugr.dist_is_editable</a></li>
    303. 

  303. <li class="toctree-l2"><a class="reference internal" href="draugr.get_version.html">draugr.get_version</a></li>
    304. 

  304. <li class="toctree-l2"><a class="reference internal" href="draugr.dlib_utilities.html">draugr.dlib_utilities</a></li>
    305. 

  305. <li class="toctree-l2"><a class="reference internal" href="draugr.drawers.html">draugr.drawers</a></li>
    306. 

  306. <li class="toctree-l2"><a class="reference internal" href="draugr.entry_points.html">draugr.entry_points</a></li>
    307. 

  307. <li class="toctree-l2"><a class="reference internal" href="draugr.extensions.html">draugr.extensions</a></li>
    308. 

  308. <li class="toctree-l2"><a class="reference internal" href="draugr.ffmpeg_utilities.html">draugr.ffmpeg_utilities</a></li>
    309. 

  309. <li class="toctree-l2"><a class="reference internal" href="draugr.jax_utilities.html">draugr.jax_utilities</a></li>
    310. 

  310. <li class="toctree-l2 current"><a class="reference internal" href="draugr.metrics.html">draugr.metrics</a><ul class="current">
    311. 

  311. <li class="toctree-l3"><a class="reference internal" href="draugr.metrics.accumulation.html">draugr.metrics.accumulation</a></li>
    312. 

  312. <li class="toctree-l3"><a class="reference internal" href="draugr.metrics.meters.html">draugr.metrics.meters</a></li>
    313. 

  313. <li class="toctree-l3"><a class="reference internal" href="draugr.metrics.metric_aggregator.html">draugr.metrics.metric_aggregator</a></li>
    314. 

  314. <li class="toctree-l3 current"><a class="reference internal" href="draugr.metrics.metric_collection.html">draugr.metrics.metric_collection</a><ul class="current">
    315. 

  315. <li class="toctree-l4 current"><a class="current reference internal" href="#">draugr.metrics.metric_collection.MetricCollection</a></li>
    316. 

  316. </ul>
    317. 

  317. </li>
    318. 

  318. <li class="toctree-l3"><a class="reference internal" href="draugr.metrics.metric_summary.html">draugr.metrics.metric_summary</a></li>
    319. 

  319. <li class="toctree-l3"><a class="reference internal" href="draugr.metrics.plotting.html">draugr.metrics.plotting</a></li>
    320. 

  320. </ul>
    321. 

  321. </li>
    322. 

  322. <li class="toctree-l2"><a class="reference internal" href="draugr.multiprocessing_utilities.html">draugr.multiprocessing_utilities</a></li>
    323. 

  323. <li class="toctree-l2"><a class="reference internal" href="draugr.numpy_utilities.html">draugr.numpy_utilities</a></li>
    324. 

  324. <li class="toctree-l2"><a class="reference internal" href="draugr.opencv_utilities.html">draugr.opencv_utilities</a></li>
    325. 

  325. <li class="toctree-l2"><a class="reference internal" href="draugr.os_utilities.html">draugr.os_utilities</a></li>
    326. 

  326. <li class="toctree-l2"><a class="reference internal" href="draugr.pandas_utilities.html">draugr.pandas_utilities</a></li>
    327. 

  327. <li class="toctree-l2"><a class="reference internal" href="draugr.pygame_utilities.html">draugr.pygame_utilities</a></li>
    328. 

  328. <li class="toctree-l2"><a class="reference internal" href="draugr.python_utilities.html">draugr.python_utilities</a></li>
    329. 

  329. <li class="toctree-l2"><a class="reference internal" href="draugr.random_utilities.html">draugr.random_utilities</a></li>
    330. 

  330. <li class="toctree-l2"><a class="reference internal" href="draugr.scipy_utilities.html">draugr.scipy_utilities</a></li>
    331. 

  331. <li class="toctree-l2"><a class="reference internal" href="draugr.stopping.html">draugr.stopping</a></li>
    332. 

  332. <li class="toctree-l2"><a class="reference internal" href="draugr.tensorboard_utilities.html">draugr.tensorboard_utilities</a></li>
    333. 

  333. <li class="toctree-l2"><a class="reference internal" href="draugr.threading_utilities.html">draugr.threading_utilities</a></li>
    334. 

  334. <li class="toctree-l2"><a class="reference internal" href="draugr.torch_utilities.html">draugr.torch_utilities</a></li>
    335. 

  335. <li class="toctree-l2"><a class="reference internal" href="draugr.tqdm_utilities.html">draugr.tqdm_utilities</a></li>
    336. 

  336. <li class="toctree-l2"><a class="reference internal" href="draugr.visualisation.html">draugr.visualisation</a></li>
    337. 

  337. <li class="toctree-l2"><a class="reference internal" href="draugr.writers.html">draugr.writers</a></li>
    338. 

  338. </ul>
    339. 

  339. </li>
    340. 

  340. </ul>
    341. 

  341. <p class="caption" role="heading"><span class="caption-text">Notes</span></p>
    342. 

  342. <ul>
    343. 

  343. <li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
    344. 

  344. </ul>
    345. 

  345. 

  346. <div class="relations">
    347. 

  347. <h3>Related Topics</h3>
    348. 

  348. <ul>
    349. 

  349.   <li><a href="../index.html">Documentation overview</a><ul>
    350. 

  350.   <li><a href="draugr.html">draugr</a><ul>
    351. 

  351.   <li><a href="draugr.metrics.html">draugr.metrics</a><ul>
    352. 

  352.   <li><a href="draugr.metrics.metric_collection.html">draugr.metrics.metric_collection</a><ul>
    353. 

  353.       <li>Previous: <a href="draugr.metrics.metric_collection.html" title="previous chapter">draugr.metrics.metric_collection</a></li>
    354. 

  354.       <li>Next: <a href="draugr.metrics.metric_summary.html" title="next chapter">draugr.metrics.metric_summary</a></li>
    355. 

  355.   </ul></li>
    356. 

  356.   </ul></li>
    357. 

  357.   </ul></li>
    358. 

  358.   </ul></li>
    359. 

  359. </ul>
    360. 

  360. </div>
    361. 

  361. <div id="searchbox" style="display: none" role="search">
    362. 

  362.   <h3 id="searchlabel">Quick search</h3>
    363. 

  363.     <div class="searchformwrapper">
    364. 

  364.     <form class="search" action="../search.html" method="get">
    365. 

  365.       <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
    366. 

  366.       <input type="submit" value="Go" />
    367. 

  367.     </form>
    368. 

  368.     </div>
    369. 

  369. </div>
    370. 

  370. <script>document.getElementById('searchbox').style.display = "block"</script>
    371. 

  371. 

  372. 

  373. 

  374. 

  375. 

  376. 

  377. 

  378. 

  379.         </div>
    380. 

  380.       </div>
    381. 

  381.       <div class="clearer"></div>
    382. 

  382.     </div>
    383. 

  383.     <div class="footer">
    384. 

  384.       &copy;.
    385. 

  385.       
    386. 

  386.       |
    387. 

  387.       Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a>
    388. 

  388.       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
    389. 

  389.       
    390. 

  390.       |
    391. 

  391.       <a href="../_sources/generated/draugr.metrics.metric_collection.MetricCollection.rst.txt"
    392. 

  392.           rel="nofollow">Page source</a>
    393. 

  393.     </div>
    394. 

  394. 

  395.     
    396. 

  396. 

  397.     
    398. 

  398.   </body>
    399. 

  399. </html>
    400.