Finish 2.0.2

jonas-eschle · Nov 5, 2017 · 83f7c62 · 83f7c62
2 parents 56e595c + 59e43ba
commit 83f7c62
Show file tree

Hide file tree

Showing 130 changed files with 436 additions and 591 deletions.
diff --git a/README.rst b/README.rst
@@ -34,13 +34,12 @@ Want to test whether your reweighting did overfit? Use train\_similar:
 
 .. code:: python
 
-    from raredecay.data import HEPDataStorage
-    from raredecay.score import train_similar
+    import raredecay as rd  
 
-    mc_data = HEPDataStorage(df, weights=*pd.Series weights*, target=0)
-    real_data = HEPDataStorage(df, weights=*pd.Series weights*, target=1)
+    mc_data = rd.data.HEPDataStorage(df, weights=*pd.Series weights*, target=0)  
+    real_data = rd.data.HEPDataStorage(df, weights=*pd.Series weights*, target=1)  
 
-    score = train_similar(mc_data, real_data, old_mc_weights=1 *or whatever weights the mc had before*)
+    score = rd.score.train_similar(mc_data, real_data, old_mc_weights=1 *or whatever weights the mc had before*)
 
 Getting started right now
 -------------------------
@@ -55,61 +54,56 @@ Documentation and API
 ---------------------
 
 The API as well as the documentation:
-`Documentation <https://mayou36.bitbucket.io/raredecay/docs/>`__
+`Documentation <https://mayou36.github.io/raredecay/>`__
 
 Setup and installation
 ----------------------
 
-Depending on which functionality you want to use, you may consider different installations.
+Anaconda
+~~~~~~~~
 
+Easiest way: use conda to install everything (except of the rep, which
+has to be upgraded with pip for some functionalities)
 
+::
 
-Everything (reweighting incl. scoring, machine learning, ROOT bindings)
-#######################################################################
-Follow the instructions for each dependency separately and then install
-raredecay via
+    conda install raredecay -c mayou36
 
-::
+PyPI
+~~~~
 
-    pip install raredecay[all]
+The package with all extras requires root\_numpy as well as rootpy (and
+therefore a ROOT installation with python-bindings) to be installed on
+your system. If that is not the case, some functions won't work.
 
-Machine learning, advanced scores
-#################################
-First install the following version of REP (the -U can be omitted, but
-is recommended to have the newest dependencies, on the other hand may
-crashes REPs reproducibility):
+If you want to install all the extra, first install the very newest
+version of REP (may also needed with conda install) (the -U can be
+omitted, but is recommended to have the newest dependencies):
 
 ::
 
     pip install -U https://github.com/yandex/rep/archive/stratifiedkfold.zip
 
-Then install the package via
+Then, install the raredecay package (without ROOT-support) via
 
 ::
 
-    pip install -U raredecay[ml]
-
-Reweighting (without scoring)
-#############################
+    pip install raredecay
 
-To install the newest version of hep\_ml containing the
-loss-regularization (recommended, but optional).
+To make sure you can convert ROOT-NTuples, use
 
 ::
 
-    pip install -U git+https://github.com/arogozhnikov/hep_ml.git
-
-Then, install the raredecay package (without ROOT-support) via
-
-::
+    pip install raredecay[root]  # *use raredecay\[root\] in a zsh-console*
 
-    pip install raredecay
+or, instead of root/additionally (comma separated) ``reweight`` or
+``reweight`` for the specific functionalities.
 
-To make sure you can convert ROOT-NTuples, use
+In order to have all functionalities, use
 
 ::
 
-    pip install raredecay[root]  # *use raredecay\[root\] in a zsh-console*
+    pip install raredecay[all]
 
 As it is a young package still under developement, it may receive
 regular updates and improvements and it is probably a good idea to

diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 45d85208917f4dd82495c6084c643829
+config: b938d3c4c4940cb822b661b64e2a60dd
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Overview: module code &mdash; Raredecay 2.0.1 documentation</title>
+  <title>Overview: module code &mdash; Raredecay 2.0.2 documentation</title>
 
 
 
@@ -33,7 +33,7 @@
         <link rel="index" title="Index"
               href="../genindex.html"/>
         <link rel="search" title="Search" href="../search.html"/>
-    <link rel="top" title="Raredecay 2.0.1 documentation" href="../index.html"/> 
+    <link rel="top" title="Raredecay 2.0.2 documentation" href="../index.html"/> 
 
 
   <script src="../_static/js/modernizr.min.js"></script>
@@ -61,7 +61,7 @@
 
 
               <div class="version">
-                2.0.1
+                2.0.2
               </div>
 
 
@@ -181,7 +181,7 @@ <h1>All modules for which code is available</h1>
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../',
-            VERSION:'2.0.1',
+            VERSION:'2.0.2',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

diff --git a/docs/_modules/raredecay/analysis/compatibility_reweight.html b/docs/_modules/raredecay/analysis/compatibility_reweight.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>raredecay.analysis.compatibility_reweight &mdash; Raredecay 2.0.1 documentation</title>
+  <title>raredecay.analysis.compatibility_reweight &mdash; Raredecay 2.0.2 documentation</title>
 
 
 
@@ -33,7 +33,7 @@
         <link rel="index" title="Index"
               href="../../../genindex.html"/>
         <link rel="search" title="Search" href="../../../search.html"/>
-    <link rel="top" title="Raredecay 2.0.1 documentation" href="../../../index.html"/>
+    <link rel="top" title="Raredecay 2.0.2 documentation" href="../../../index.html"/>
         <link rel="up" title="Module code" href="../../index.html"/> 
 
 
@@ -62,7 +62,7 @@
 
 
               <div class="version">
-                2.0.1
+                2.0.2
               </div>
 
 
@@ -283,7 +283,7 @@ <h1>Source code for raredecay.analysis.compatibility_reweight</h1><div class="hi
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../../../',
-            VERSION:'2.0.1',
+            VERSION:'2.0.2',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

diff --git a/docs/_modules/raredecay/analysis/ml_analysis.html b/docs/_modules/raredecay/analysis/ml_analysis.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>raredecay.analysis.ml_analysis &mdash; Raredecay 2.0.1 documentation</title>
+  <title>raredecay.analysis.ml_analysis &mdash; Raredecay 2.0.2 documentation</title>
 
 
 
@@ -33,7 +33,7 @@
         <link rel="index" title="Index"
               href="../../../genindex.html"/>
         <link rel="search" title="Search" href="../../../search.html"/>
-    <link rel="top" title="Raredecay 2.0.1 documentation" href="../../../index.html"/>
+    <link rel="top" title="Raredecay 2.0.2 documentation" href="../../../index.html"/>
         <link rel="up" title="Module code" href="../../index.html"/> 
 
 
@@ -62,7 +62,7 @@
 
 
               <div class="version">
-                2.0.1
+                2.0.2
               </div>
 
 
@@ -1626,7 +1626,7 @@ <h1>Source code for raredecay.analysis.ml_analysis</h1><div class="highlight"><p
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../../../',
-            VERSION:'2.0.1',
+            VERSION:'2.0.2',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

diff --git a/docs/_modules/raredecay/analysis/physical_analysis.html b/docs/_modules/raredecay/analysis/physical_analysis.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>raredecay.analysis.physical_analysis &mdash; Raredecay 2.0.1 documentation</title>
+  <title>raredecay.analysis.physical_analysis &mdash; Raredecay 2.0.2 documentation</title>
 
 
 
@@ -33,7 +33,7 @@
         <link rel="index" title="Index"
               href="../../../genindex.html"/>
         <link rel="search" title="Search" href="../../../search.html"/>
-    <link rel="top" title="Raredecay 2.0.1 documentation" href="../../../index.html"/>
+    <link rel="top" title="Raredecay 2.0.2 documentation" href="../../../index.html"/>
         <link rel="up" title="Module code" href="../../index.html"/> 
 
 
@@ -62,7 +62,7 @@
 
 
               <div class="version">
-                2.0.1
+                2.0.2
               </div>
 
 
@@ -925,7 +925,7 @@ <h1>Source code for raredecay.analysis.physical_analysis</h1><div class="highlig
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../../../',
-            VERSION:'2.0.1',
+            VERSION:'2.0.2',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

diff --git a/docs/_modules/raredecay/analysis/reweight.html b/docs/_modules/raredecay/analysis/reweight.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>raredecay.analysis.reweight &mdash; Raredecay 2.0.1 documentation</title>
+  <title>raredecay.analysis.reweight &mdash; Raredecay 2.0.2 documentation</title>
 
 
 
@@ -33,7 +33,7 @@
         <link rel="index" title="Index"
               href="../../../genindex.html"/>
         <link rel="search" title="Search" href="../../../search.html"/>
-    <link rel="top" title="Raredecay 2.0.1 documentation" href="../../../index.html"/>
+    <link rel="top" title="Raredecay 2.0.2 documentation" href="../../../index.html"/>
         <link rel="up" title="Module code" href="../../index.html"/> 
 
 
@@ -62,7 +62,7 @@
 
 
               <div class="version">
-                2.0.1
+                2.0.2
               </div>
 
 
@@ -702,7 +702,7 @@ <h1>Source code for raredecay.analysis.reweight</h1><div class="highlight"><pre>
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../../../',
-            VERSION:'2.0.1',
+            VERSION:'2.0.2',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

diff --git a/docs/_modules/raredecay/analysis/statistics.html b/docs/_modules/raredecay/analysis/statistics.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>raredecay.analysis.statistics &mdash; Raredecay 2.0.1 documentation</title>
+  <title>raredecay.analysis.statistics &mdash; Raredecay 2.0.2 documentation</title>
 
 
 
@@ -33,7 +33,7 @@
         <link rel="index" title="Index"
               href="../../../genindex.html"/>
         <link rel="search" title="Search" href="../../../search.html"/>
-    <link rel="top" title="Raredecay 2.0.1 documentation" href="../../../index.html"/>
+    <link rel="top" title="Raredecay 2.0.2 documentation" href="../../../index.html"/>
         <link rel="up" title="Module code" href="../../index.html"/> 
 
 
@@ -62,7 +62,7 @@
 
 
               <div class="version">
-                2.0.1
+                2.0.2
               </div>
 
 
@@ -912,7 +912,7 @@ <h1>Source code for raredecay.analysis.statistics</h1><div class="highlight"><pr
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../../../',
-            VERSION:'2.0.1',
+            VERSION:'2.0.2',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

diff --git a/docs/_modules/raredecay/analysis/statistics_tmp.html b/docs/_modules/raredecay/analysis/statistics_tmp.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>raredecay.analysis.statistics_tmp &mdash; Raredecay 2.0.1 documentation</title>
+  <title>raredecay.analysis.statistics_tmp &mdash; Raredecay 2.0.2 documentation</title>
 
 
 
@@ -33,7 +33,7 @@
         <link rel="index" title="Index"
               href="../../../genindex.html"/>
         <link rel="search" title="Search" href="../../../search.html"/>
-    <link rel="top" title="Raredecay 2.0.1 documentation" href="../../../index.html"/>
+    <link rel="top" title="Raredecay 2.0.2 documentation" href="../../../index.html"/>
         <link rel="up" title="Module code" href="../../index.html"/> 
 
 
@@ -62,7 +62,7 @@
 
 
               <div class="version">
-                2.0.1
+                2.0.2
               </div>
 
 
@@ -892,7 +892,7 @@ <h1>Source code for raredecay.analysis.statistics_tmp</h1><div class="highlight"
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../../../',
-            VERSION:'2.0.1',
+            VERSION:'2.0.2',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

diff --git a/docs/_modules/raredecay/globals_.html b/docs/_modules/raredecay/globals_.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>raredecay.globals_ &mdash; Raredecay 2.0.1 documentation</title>
+  <title>raredecay.globals_ &mdash; Raredecay 2.0.2 documentation</title>
 
 
 
@@ -33,7 +33,7 @@
         <link rel="index" title="Index"
               href="../../genindex.html"/>
         <link rel="search" title="Search" href="../../search.html"/>
-    <link rel="top" title="Raredecay 2.0.1 documentation" href="../../index.html"/>
+    <link rel="top" title="Raredecay 2.0.2 documentation" href="../../index.html"/>
         <link rel="up" title="Module code" href="../index.html"/> 
 
 
@@ -62,7 +62,7 @@
 
 
               <div class="version">
-                2.0.1
+                2.0.2
               </div>
 
 
@@ -285,7 +285,7 @@ <h1>Source code for raredecay.globals_</h1><div class="highlight"><pre>
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../../',
-            VERSION:'2.0.1',
+            VERSION:'2.0.2',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true