ipfml.metrics.html 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274
  1. <!DOCTYPE html>
  2. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
  3. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
  4. <head>
  5. <meta charset="utf-8">
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <title>ipfml.metrics &mdash; ipfml v0.4.1 documentation</title>
  8. <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  9. <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  10. <link rel="index" title="Index" href="../genindex.html" />
  11. <link rel="search" title="Search" href="../search.html" />
  12. <link rel="next" title="ipfml.utils" href="ipfml.utils.html" />
  13. <link rel="prev" title="Documentation of ipfml" href="../ipfml.html" />
  14. <script src="../_static/js/modernizr.min.js"></script>
  15. </head>
  16. <body class="wy-body-for-nav">
  17. <div class="wy-grid-for-nav">
  18. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  19. <div class="wy-side-scroll">
  20. <div class="wy-side-nav-search">
  21. <a href="../index.html" class="icon icon-home"> ipfml
  22. </a>
  23. <div class="version">
  24. 0.4.1
  25. </div>
  26. <div role="search">
  27. <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  28. <input type="text" name="q" placeholder="Search docs" />
  29. <input type="hidden" name="check_keywords" value="yes" />
  30. <input type="hidden" name="area" value="default" />
  31. </form>
  32. </div>
  33. </div>
  34. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  35. <p class="caption"><span class="caption-text">Contents:</span></p>
  36. <ul class="current">
  37. <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
  38. <li class="toctree-l1 current"><a class="reference internal" href="../ipfml.html">Documentation of ipfml</a><ul class="current">
  39. <li class="toctree-l2 current"><a class="current reference internal" href="#">ipfml.metrics</a></li>
  40. <li class="toctree-l2"><a class="reference internal" href="ipfml.utils.html">ipfml.utils</a></li>
  41. <li class="toctree-l2"><a class="reference internal" href="ipfml.exceptions.html">ipfml.exceptions</a></li>
  42. <li class="toctree-l2"><a class="reference internal" href="../ipfml.html#ipfml-filters">ipfml.filters</a></li>
  43. <li class="toctree-l2"><a class="reference internal" href="../ipfml.html#ipfml-iqa">ipfml.iqa</a></li>
  44. <li class="toctree-l2"><a class="reference internal" href="../ipfml.html#ipfml-processing">ipfml.processing</a></li>
  45. </ul>
  46. </li>
  47. <li class="toctree-l1"><a class="reference internal" href="../examples.html">Examples</a></li>
  48. <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
  49. </ul>
  50. </div>
  51. </div>
  52. </nav>
  53. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  54. <nav class="wy-nav-top" aria-label="top navigation">
  55. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  56. <a href="../index.html">ipfml</a>
  57. </nav>
  58. <div class="wy-nav-content">
  59. <div class="rst-content">
  60. <div role="navigation" aria-label="breadcrumbs navigation">
  61. <ul class="wy-breadcrumbs">
  62. <li><a href="../index.html">Docs</a> &raquo;</li>
  63. <li><a href="../ipfml.html">Documentation of ipfml</a> &raquo;</li>
  64. <li>ipfml.metrics</li>
  65. <li class="wy-breadcrumbs-aside">
  66. <a href="https://github.com/prise-3d/ipfml/blob/master/docs/source/ipfml/ipfml.metrics.rst" class="fa fa-github"> Edit on GitHub</a>
  67. </li>
  68. </ul>
  69. <hr/>
  70. </div>
  71. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  72. <div itemprop="articleBody">
  73. <div class="section" id="module-ipfml.metrics">
  74. <span id="ipfml-metrics"></span><h1>ipfml.metrics<a class="headerlink" href="#module-ipfml.metrics" title="Permalink to this headline">¶</a></h1>
  75. <p>Contains all metrics used for model results comparisons</p>
  76. <p class="rubric">Functions</p>
  77. <table border="1" class="longtable docutils">
  78. <colgroup>
  79. <col width="10%" />
  80. <col width="90%" />
  81. </colgroup>
  82. <tbody valign="top">
  83. <tr class="row-odd"><td><a class="reference internal" href="#ipfml.metrics.coefficient_of_determination" title="ipfml.metrics.coefficient_of_determination"><code class="xref py py-obj docutils literal notranslate"><span class="pre">coefficient_of_determination</span></code></a>(y,&nbsp;predicted)</td>
  84. <td>Returns the coefficient of determination between <cite>y</cite> and <cite>y_predicted</cite> values</td>
  85. </tr>
  86. </tbody>
  87. </table>
  88. <dl class="function">
  89. <dt id="ipfml.metrics.coefficient_of_determination">
  90. <code class="descclassname">ipfml.metrics.</code><code class="descname">coefficient_of_determination</code><span class="sig-paren">(</span><em>y</em>, <em>predicted</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/ipfml/metrics.html#coefficient_of_determination"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ipfml.metrics.coefficient_of_determination" title="Permalink to this definition">¶</a></dt>
  91. <dd><p>Returns the coefficient of determination between <cite>y</cite> and <cite>y_predicted</cite> values</p>
  92. <table class="docutils field-list" frame="void" rules="none">
  93. <col class="field-name" />
  94. <col class="field-body" />
  95. <tbody valign="top">
  96. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  97. <li><strong>y</strong> – array of reference values</li>
  98. <li><strong>predicted</strong> – array of predicted values</li>
  99. </ul>
  100. </td>
  101. </tr>
  102. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">coefficient of determination</p>
  103. </td>
  104. </tr>
  105. </tbody>
  106. </table>
  107. <p>Example:</p>
  108. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">ipfml</span> <span class="k">import</span> <span class="n">metrics</span>
  109. <span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
  110. <span class="gp">&gt;&gt;&gt; </span><span class="n">y</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span>
  111. <span class="gp">&gt;&gt;&gt; </span><span class="n">predicted</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">arange</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span> <span class="o">*</span> <span class="mf">1.05</span>
  112. <span class="gp">&gt;&gt;&gt; </span><span class="n">coeff</span> <span class="o">=</span> <span class="n">metrics</span><span class="o">.</span><span class="n">coefficient_of_determination</span><span class="p">(</span><span class="n">y</span><span class="p">,</span> <span class="n">predicted</span><span class="p">)</span>
  113. <span class="gp">&gt;&gt;&gt; </span><span class="nb">int</span><span class="p">(</span><span class="n">coeff</span><span class="p">)</span>
  114. <span class="go">1</span>
  115. </pre></div>
  116. </div>
  117. </dd></dl>
  118. </div>
  119. </div>
  120. </div>
  121. <footer>
  122. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  123. <a href="ipfml.utils.html" class="btn btn-neutral float-right" title="ipfml.utils" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
  124. <a href="../ipfml.html" class="btn btn-neutral" title="Documentation of ipfml" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
  125. </div>
  126. <hr/>
  127. <div role="contentinfo">
  128. <p>
  129. &copy; Copyright 2019, Jérôme BUISINE
  130. </p>
  131. </div>
  132. Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
  133. </footer>
  134. </div>
  135. </div>
  136. </section>
  137. </div>
  138. <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
  139. <script type="text/javascript" src="../_static/jquery.js"></script>
  140. <script type="text/javascript" src="../_static/underscore.js"></script>
  141. <script type="text/javascript" src="../_static/doctools.js"></script>
  142. <script type="text/javascript" src="../_static/language_data.js"></script>
  143. <script type="text/javascript" src="../_static/js/theme.js"></script>
  144. <script type="text/javascript">
  145. jQuery(function () {
  146. SphinxRtdTheme.Navigation.enable(true);
  147. });
  148. </script>
  149. </body>
  150. </html>