Skip to content

Commit 83f7c62

Browse files
jonas-eschlejonas-eschle
committed
Finish 2.0.2
2 parents 56e595c + 59e43ba commit 83f7c62

File tree

130 files changed

+436
-591
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

130 files changed

+436
-591
lines changed

‎README.rst

Lines changed: 27 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,12 @@ Want to test whether your reweighting did overfit? Use train\_similar:
3434

3535
.. code:: python
3636
37-
from raredecay.data import HEPDataStorage
38-
from raredecay.score import train_similar
37+
import raredecay as rd
3938
40-
mc_data = HEPDataStorage(df, weights=*pd.Series weights*, target=0)
41-
real_data = HEPDataStorage(df, weights=*pd.Series weights*, target=1)
39+
mc_data = rd.data.HEPDataStorage(df, weights=*pd.Series weights*, target=0)
40+
real_data = rd.data.HEPDataStorage(df, weights=*pd.Series weights*, target=1)
4241
43-
score = train_similar(mc_data, real_data, old_mc_weights=1 *or whatever weights the mc had before*)
42+
score = rd.score.train_similar(mc_data, real_data, old_mc_weights=1 *or whatever weights the mc had before*)
4443
4544
Getting started right now
4645
-------------------------
@@ -55,61 +54,56 @@ Documentation and API
5554
---------------------
5655

5756
The API as well as the documentation:
58-
`Documentation <https://mayou36.bitbucket.io/raredecay/docs/>`__
57+
`Documentation <https://mayou36.github.io/raredecay/>`__
5958

6059
Setup and installation
6160
----------------------
6261

63-
Depending on which functionality you want to use, you may consider different installations.
62+
Anaconda
63+
~~~~~~~~
6464

65+
Easiest way: use conda to install everything (except of the rep, which
66+
has to be upgraded with pip for some functionalities)
6567

68+
::
6669

67-
Everything (reweighting incl. scoring, machine learning, ROOT bindings)
68-
#######################################################################
69-
Follow the instructions for each dependency separately and then install
70-
raredecay via
70+
conda install raredecay -c mayou36
7171

72-
::
72+
PyPI
73+
~~~~
7374

74-
pip install raredecay[all]
75+
The package with all extras requires root\_numpy as well as rootpy (and
76+
therefore a ROOT installation with python-bindings) to be installed on
77+
your system. If that is not the case, some functions won't work.
7578

76-
Machine learning, advanced scores
77-
#################################
78-
First install the following version of REP (the -U can be omitted, but
79-
is recommended to have the newest dependencies, on the other hand may
80-
crashes REPs reproducibility):
79+
If you want to install all the extra, first install the very newest
80+
version of REP (may also needed with conda install) (the -U can be
81+
omitted, but is recommended to have the newest dependencies):
8182

8283
::
8384

8485
pip install -U https://github.com/yandex/rep/archive/stratifiedkfold.zip
8586

86-
Then install the package via
87+
Then, install the raredecay package (without ROOT-support) via
8788

8889
::
8990

90-
pip install -U raredecay[ml]
91-
92-
Reweighting (without scoring)
93-
#############################
91+
pip install raredecay
9492

95-
To install the newest version of hep\_ml containing the
96-
loss-regularization (recommended, but optional).
93+
To make sure you can convert ROOT-NTuples, use
9794

9895
::
9996

100-
pip install -U git+https://github.com/arogozhnikov/hep_ml.git
101-
102-
Then, install the raredecay package (without ROOT-support) via
103-
104-
::
97+
pip install raredecay[root] # *use raredecay\[root\] in a zsh-console*
10598

106-
pip install raredecay
99+
or, instead of root/additionally (comma separated) ``reweight`` or
100+
``reweight`` for the specific functionalities.
107101

108-
To make sure you can convert ROOT-NTuples, use
102+
In order to have all functionalities, use
109103

110104
::
111105

112-
pip install raredecay[root] # *use raredecay\[root\] in a zsh-console*
106+
pip install raredecay[all]
113107

114108
As it is a young package still under developement, it may receive
115109
regular updates and improvements and it is probably a good idea to

‎docs/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 45d85208917f4dd82495c6084c643829
3+
config: b938d3c4c4940cb822b661b64e2a60dd
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/_modules/index.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>Overview: module code &mdash; Raredecay 2.0.1 documentation</title>
11+
<title>Overview: module code &mdash; Raredecay 2.0.2 documentation</title>
1212

1313

1414

@@ -33,7 +33,7 @@
3333
<link rel="index" title="Index"
3434
href="../genindex.html"/>
3535
<link rel="search" title="Search" href="../search.html"/>
36-
<link rel="top" title="Raredecay 2.0.1 documentation" href="../index.html"/>
36+
<link rel="top" title="Raredecay 2.0.2 documentation" href="../index.html"/>
3737

3838

3939
<script src="../_static/js/modernizr.min.js"></script>
@@ -61,7 +61,7 @@
6161

6262

6363
<div class="version">
64-
2.0.1
64+
2.0.2
6565
</div>
6666

6767

@@ -181,7 +181,7 @@ <h1>All modules for which code is available</h1>
181181
<script type="text/javascript">
182182
var DOCUMENTATION_OPTIONS = {
183183
URL_ROOT:'../',
184-
VERSION:'2.0.1',
184+
VERSION:'2.0.2',
185185
COLLAPSE_INDEX:false,
186186
FILE_SUFFIX:'.html',
187187
HAS_SOURCE: true

‎docs/_modules/raredecay/analysis/compatibility_reweight.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>raredecay.analysis.compatibility_reweight &mdash; Raredecay 2.0.1 documentation</title>
11+
<title>raredecay.analysis.compatibility_reweight &mdash; Raredecay 2.0.2 documentation</title>
1212

1313

1414

@@ -33,7 +33,7 @@
3333
<link rel="index" title="Index"
3434
href="../../../genindex.html"/>
3535
<link rel="search" title="Search" href="../../../search.html"/>
36-
<link rel="top" title="Raredecay 2.0.1 documentation" href="../../../index.html"/>
36+
<link rel="top" title="Raredecay 2.0.2 documentation" href="../../../index.html"/>
3737
<link rel="up" title="Module code" href="../../index.html"/>
3838

3939

@@ -62,7 +62,7 @@
6262

6363

6464
<div class="version">
65-
2.0.1
65+
2.0.2
6666
</div>
6767

6868

@@ -283,7 +283,7 @@ <h1>Source code for raredecay.analysis.compatibility_reweight</h1><div class="hi
283283
<script type="text/javascript">
284284
var DOCUMENTATION_OPTIONS = {
285285
URL_ROOT:'../../../',
286-
VERSION:'2.0.1',
286+
VERSION:'2.0.2',
287287
COLLAPSE_INDEX:false,
288288
FILE_SUFFIX:'.html',
289289
HAS_SOURCE: true

‎docs/_modules/raredecay/analysis/ml_analysis.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>raredecay.analysis.ml_analysis &mdash; Raredecay 2.0.1 documentation</title>
11+
<title>raredecay.analysis.ml_analysis &mdash; Raredecay 2.0.2 documentation</title>
1212

1313

1414

@@ -33,7 +33,7 @@
3333
<link rel="index" title="Index"
3434
href="../../../genindex.html"/>
3535
<link rel="search" title="Search" href="../../../search.html"/>
36-
<link rel="top" title="Raredecay 2.0.1 documentation" href="../../../index.html"/>
36+
<link rel="top" title="Raredecay 2.0.2 documentation" href="../../../index.html"/>
3737
<link rel="up" title="Module code" href="../../index.html"/>
3838

3939

@@ -62,7 +62,7 @@
6262

6363

6464
<div class="version">
65-
2.0.1
65+
2.0.2
6666
</div>
6767

6868

@@ -1626,7 +1626,7 @@ <h1>Source code for raredecay.analysis.ml_analysis</h1><div class="highlight"><p
16261626
<script type="text/javascript">
16271627
var DOCUMENTATION_OPTIONS = {
16281628
URL_ROOT:'../../../',
1629-
VERSION:'2.0.1',
1629+
VERSION:'2.0.2',
16301630
COLLAPSE_INDEX:false,
16311631
FILE_SUFFIX:'.html',
16321632
HAS_SOURCE: true

‎docs/_modules/raredecay/analysis/physical_analysis.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>raredecay.analysis.physical_analysis &mdash; Raredecay 2.0.1 documentation</title>
11+
<title>raredecay.analysis.physical_analysis &mdash; Raredecay 2.0.2 documentation</title>
1212

1313

1414

@@ -33,7 +33,7 @@
3333
<link rel="index" title="Index"
3434
href="../../../genindex.html"/>
3535
<link rel="search" title="Search" href="../../../search.html"/>
36-
<link rel="top" title="Raredecay 2.0.1 documentation" href="../../../index.html"/>
36+
<link rel="top" title="Raredecay 2.0.2 documentation" href="../../../index.html"/>
3737
<link rel="up" title="Module code" href="../../index.html"/>
3838

3939

@@ -62,7 +62,7 @@
6262

6363

6464
<div class="version">
65-
2.0.1
65+
2.0.2
6666
</div>
6767

6868

@@ -925,7 +925,7 @@ <h1>Source code for raredecay.analysis.physical_analysis</h1><div class="highlig
925925
<script type="text/javascript">
926926
var DOCUMENTATION_OPTIONS = {
927927
URL_ROOT:'../../../',
928-
VERSION:'2.0.1',
928+
VERSION:'2.0.2',
929929
COLLAPSE_INDEX:false,
930930
FILE_SUFFIX:'.html',
931931
HAS_SOURCE: true

‎docs/_modules/raredecay/analysis/reweight.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>raredecay.analysis.reweight &mdash; Raredecay 2.0.1 documentation</title>
11+
<title>raredecay.analysis.reweight &mdash; Raredecay 2.0.2 documentation</title>
1212

1313

1414

@@ -33,7 +33,7 @@
3333
<link rel="index" title="Index"
3434
href="../../../genindex.html"/>
3535
<link rel="search" title="Search" href="../../../search.html"/>
36-
<link rel="top" title="Raredecay 2.0.1 documentation" href="../../../index.html"/>
36+
<link rel="top" title="Raredecay 2.0.2 documentation" href="../../../index.html"/>
3737
<link rel="up" title="Module code" href="../../index.html"/>
3838

3939

@@ -62,7 +62,7 @@
6262

6363

6464
<div class="version">
65-
2.0.1
65+
2.0.2
6666
</div>
6767

6868

@@ -702,7 +702,7 @@ <h1>Source code for raredecay.analysis.reweight</h1><div class="highlight"><pre>
702702
<script type="text/javascript">
703703
var DOCUMENTATION_OPTIONS = {
704704
URL_ROOT:'../../../',
705-
VERSION:'2.0.1',
705+
VERSION:'2.0.2',
706706
COLLAPSE_INDEX:false,
707707
FILE_SUFFIX:'.html',
708708
HAS_SOURCE: true

‎docs/_modules/raredecay/analysis/statistics.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>raredecay.analysis.statistics &mdash; Raredecay 2.0.1 documentation</title>
11+
<title>raredecay.analysis.statistics &mdash; Raredecay 2.0.2 documentation</title>
1212

1313

1414

@@ -33,7 +33,7 @@
3333
<link rel="index" title="Index"
3434
href="../../../genindex.html"/>
3535
<link rel="search" title="Search" href="../../../search.html"/>
36-
<link rel="top" title="Raredecay 2.0.1 documentation" href="../../../index.html"/>
36+
<link rel="top" title="Raredecay 2.0.2 documentation" href="../../../index.html"/>
3737
<link rel="up" title="Module code" href="../../index.html"/>
3838

3939

@@ -62,7 +62,7 @@
6262

6363

6464
<div class="version">
65-
2.0.1
65+
2.0.2
6666
</div>
6767

6868

@@ -912,7 +912,7 @@ <h1>Source code for raredecay.analysis.statistics</h1><div class="highlight"><pr
912912
<script type="text/javascript">
913913
var DOCUMENTATION_OPTIONS = {
914914
URL_ROOT:'../../../',
915-
VERSION:'2.0.1',
915+
VERSION:'2.0.2',
916916
COLLAPSE_INDEX:false,
917917
FILE_SUFFIX:'.html',
918918
HAS_SOURCE: true

‎docs/_modules/raredecay/analysis/statistics_tmp.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>raredecay.analysis.statistics_tmp &mdash; Raredecay 2.0.1 documentation</title>
11+
<title>raredecay.analysis.statistics_tmp &mdash; Raredecay 2.0.2 documentation</title>
1212

1313

1414

@@ -33,7 +33,7 @@
3333
<link rel="index" title="Index"
3434
href="../../../genindex.html"/>
3535
<link rel="search" title="Search" href="../../../search.html"/>
36-
<link rel="top" title="Raredecay 2.0.1 documentation" href="../../../index.html"/>
36+
<link rel="top" title="Raredecay 2.0.2 documentation" href="../../../index.html"/>
3737
<link rel="up" title="Module code" href="../../index.html"/>
3838

3939

@@ -62,7 +62,7 @@
6262

6363

6464
<div class="version">
65-
2.0.1
65+
2.0.2
6666
</div>
6767

6868

@@ -892,7 +892,7 @@ <h1>Source code for raredecay.analysis.statistics_tmp</h1><div class="highlight"
892892
<script type="text/javascript">
893893
var DOCUMENTATION_OPTIONS = {
894894
URL_ROOT:'../../../',
895-
VERSION:'2.0.1',
895+
VERSION:'2.0.2',
896896
COLLAPSE_INDEX:false,
897897
FILE_SUFFIX:'.html',
898898
HAS_SOURCE: true

‎docs/_modules/raredecay/globals_.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>raredecay.globals_ &mdash; Raredecay 2.0.1 documentation</title>
11+
<title>raredecay.globals_ &mdash; Raredecay 2.0.2 documentation</title>
1212

1313

1414

@@ -33,7 +33,7 @@
3333
<link rel="index" title="Index"
3434
href="../../genindex.html"/>
3535
<link rel="search" title="Search" href="../../search.html"/>
36-
<link rel="top" title="Raredecay 2.0.1 documentation" href="../../index.html"/>
36+
<link rel="top" title="Raredecay 2.0.2 documentation" href="../../index.html"/>
3737
<link rel="up" title="Module code" href="../index.html"/>
3838

3939

@@ -62,7 +62,7 @@
6262

6363

6464
<div class="version">
65-
2.0.1
65+
2.0.2
6666
</div>
6767

6868

@@ -285,7 +285,7 @@ <h1>Source code for raredecay.globals_</h1><div class="highlight"><pre>
285285
<script type="text/javascript">
286286
var DOCUMENTATION_OPTIONS = {
287287
URL_ROOT:'../../',
288-
VERSION:'2.0.1',
288+
VERSION:'2.0.2',
289289
COLLAPSE_INDEX:false,
290290
FILE_SUFFIX:'.html',
291291
HAS_SOURCE: true

0 commit comments

Comments
 (0)