metrics.html 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246
  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.8 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. <script src="../../_static/js/modernizr.min.js"></script>
  13. </head>
  14. <body class="wy-body-for-nav">
  15. <div class="wy-grid-for-nav">
  16. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  17. <div class="wy-side-scroll">
  18. <div class="wy-side-nav-search">
  19. <a href="../../index.html" class="icon icon-home"> ipfml
  20. </a>
  21. <div class="version">
  22. 0.4.8
  23. </div>
  24. <div role="search">
  25. <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
  26. <input type="text" name="q" placeholder="Search docs" />
  27. <input type="hidden" name="check_keywords" value="yes" />
  28. <input type="hidden" name="area" value="default" />
  29. </form>
  30. </div>
  31. </div>
  32. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  33. <p class="caption"><span class="caption-text">Contents:</span></p>
  34. <ul>
  35. <li class="toctree-l1"><a class="reference internal" href="../../description.html">Description</a></li>
  36. <li class="toctree-l1"><a class="reference internal" href="../../ipfml.html">Documentation</a></li>
  37. <li class="toctree-l1"><a class="reference internal" href="../../examples.html">Examples</a></li>
  38. <li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Contributing</a></li>
  39. </ul>
  40. </div>
  41. </div>
  42. </nav>
  43. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  44. <nav class="wy-nav-top" aria-label="top navigation">
  45. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  46. <a href="../../index.html">ipfml</a>
  47. </nav>
  48. <div class="wy-nav-content">
  49. <div class="rst-content">
  50. <div role="navigation" aria-label="breadcrumbs navigation">
  51. <ul class="wy-breadcrumbs">
  52. <li><a href="../../index.html">Docs</a> &raquo;</li>
  53. <li><a href="../index.html">Module code</a> &raquo;</li>
  54. <li>ipfml.metrics</li>
  55. <li class="wy-breadcrumbs-aside">
  56. </li>
  57. </ul>
  58. <hr/>
  59. </div>
  60. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  61. <div itemprop="articleBody">
  62. <h1>Source code for ipfml.metrics</h1><div class="highlight"><pre>
  63. <span></span><span class="sd">&quot;&quot;&quot;</span>
  64. <span class="sd">Contains all metrics used for model results comparisons</span>
  65. <span class="sd">&quot;&quot;&quot;</span>
  66. <span class="c1"># main imports</span>
  67. <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
  68. <div class="viewcode-block" id="coefficient_of_determination"><a class="viewcode-back" href="../../ipfml/ipfml.metrics.html#ipfml.metrics.coefficient_of_determination">[docs]</a><span class="k">def</span> <span class="nf">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>
  69. <span class="sd">&quot;&quot;&quot;Returns the coefficient of determination between `y` and `y_predicted` values</span>
  70. <span class="sd"> Args:</span>
  71. <span class="sd"> y: array of reference values</span>
  72. <span class="sd"> predicted: array of predicted values</span>
  73. <span class="sd"> Returns:</span>
  74. <span class="sd"> coefficient of determination</span>
  75. <span class="sd"> Example:</span>
  76. <span class="sd"> &gt;&gt;&gt; from ipfml import metrics</span>
  77. <span class="sd"> &gt;&gt;&gt; import numpy as np</span>
  78. <span class="sd"> &gt;&gt;&gt; y = np.arange(10)</span>
  79. <span class="sd"> &gt;&gt;&gt; predicted = np.arange(10) * 1.05</span>
  80. <span class="sd"> &gt;&gt;&gt; coeff = metrics.coefficient_of_determination(y, predicted)</span>
  81. <span class="sd"> &gt;&gt;&gt; int(coeff)</span>
  82. <span class="sd"> 1</span>
  83. <span class="sd"> &quot;&quot;&quot;</span>
  84. <span class="n">y</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">y</span><span class="p">)</span>
  85. <span class="n">predicted</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">predicted</span><span class="p">)</span>
  86. <span class="n">y_mean</span> <span class="o">=</span> <span class="n">y</span><span class="o">.</span><span class="n">mean</span><span class="p">()</span>
  87. <span class="n">numerator_sum</span> <span class="o">=</span> <span class="mi">0</span>
  88. <span class="n">denominator_sum</span> <span class="o">=</span> <span class="mi">0</span>
  89. <span class="k">for</span> <span class="n">id_val</span><span class="p">,</span> <span class="n">val</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">y</span><span class="p">):</span>
  90. <span class="n">numerator_sum</span> <span class="o">+=</span> <span class="p">(</span><span class="n">predicted</span><span class="p">[</span><span class="n">id_val</span><span class="p">]</span> <span class="o">-</span> <span class="n">y_mean</span><span class="p">)</span> <span class="o">*</span> <span class="p">(</span>
  91. <span class="n">predicted</span><span class="p">[</span><span class="n">id_val</span><span class="p">]</span> <span class="o">-</span> <span class="n">y_mean</span><span class="p">)</span>
  92. <span class="n">denominator_sum</span> <span class="o">+=</span> <span class="p">(</span><span class="n">val</span> <span class="o">-</span> <span class="n">y_mean</span><span class="p">)</span> <span class="o">*</span> <span class="p">(</span><span class="n">val</span> <span class="o">-</span> <span class="n">y_mean</span><span class="p">)</span>
  93. <span class="k">return</span> <span class="n">numerator_sum</span> <span class="o">/</span> <span class="n">denominator_sum</span></div>
  94. </pre></div>
  95. </div>
  96. </div>
  97. <footer>
  98. <hr/>
  99. <div role="contentinfo">
  100. <p>
  101. &copy; Copyright 2019, Jérôme BUISINE
  102. </p>
  103. </div>
  104. 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>.
  105. </footer>
  106. </div>
  107. </div>
  108. </section>
  109. </div>
  110. <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
  111. <script type="text/javascript" src="../../_static/jquery.js"></script>
  112. <script type="text/javascript" src="../../_static/underscore.js"></script>
  113. <script type="text/javascript" src="../../_static/doctools.js"></script>
  114. <script type="text/javascript" src="../../_static/language_data.js"></script>
  115. <script type="text/javascript" src="../../_static/js/theme.js"></script>
  116. <script type="text/javascript">
  117. jQuery(function () {
  118. SphinxRtdTheme.Navigation.enable(true);
  119. });
  120. </script>
  121. </body>
  122. </html>