Skip to main content

Experiment Analysis Library

Project description

Build status Code coverage Latest PyPI version Development Status Python Versions License Documentation Status

A/B tests (a.k.a. Randomized Controlled Trials or Experiments) have been widely applied in different industries to optimize business processes and user experience. ExpAn (Experiment Analysis) is a Python library developed for the statistical analysis of such experiments and to standardise the data structures used.

The data structures and functionality of ExpAn are generic such that they can be used by both data scientists optimizing a user interface and biologists running wet-lab experiments. The library is also standalone and can be imported and used from within other projects and from the command line.

Documentation

The latest stable version is 1.4.0. Please check out our tutorial and documentation.

Installation

Stable release

To install ExpAn, run this command in your terminal:

$ pip install expan

From sources

The sources for ExpAn can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/zalando/expan

Or download the tarball:

$ curl  -OL https://github.com/zalando/expan/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

License

The MIT License (MIT)

Copyright © [2016] Zalando SE, https://tech.zalando.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Change Log

v1.4.0 (2019-07-05)

Full Changelog

Closed issues:

  • Why features are iterated in a for loop? #243

Merged pull requests:

v1.3.9 (2018-09-10)

Full Changelog

v1.3.8 (2018-09-10)

Full Changelog

Merged pull requests:

  • Changed chi-square test, removed frequencies computation #240 (daryadedik)

v1.3.7 (2018-09-04)

Full Changelog

Merged pull requests:

v1.3.6 (2018-08-06)

Full Changelog

Merged pull requests:

v1.3.5 (2018-08-02)

Full Changelog

Merged pull requests:

v1.3.3 (2018-07-26)

Full Changelog

Merged pull requests:

v1.3.2 (2018-07-23)

Full Changelog

Merged pull requests:

v1.3.1 (2018-07-01)

Full Changelog

v1.2.6 (2018-07-01)

Full Changelog

Merged pull requests:

v1.2.5 (2018-06-22)

Full Changelog

Merged pull requests:

v1.2.4 (2018-05-31)

Full Changelog

Merged pull requests:

  • Remove null analysis results from the analysis results files #219 (daryadedik)

v1.2.3 (2018-05-30)

Full Changelog

Merged pull requests:

  • Removed deep copy of the data in statistical test construction #218 (daryadedik)

v1.2.2 (2018-05-30)

Full Changelog

Merged pull requests:

v1.2.1 (2018-05-29)

Full Changelog

Merged pull requests:

  • Added merge_with class method for merging two multiple test suite results and tests #216 (daryadedik)

  • List of filtered columns as filtered_columns metadata information #215 (daryadedik)

v1.2.0 (2018-05-25)

Full Changelog

Merged pull requests:

v1.1.0 (2018-05-24)

Full Changelog

Merged pull requests:

v1.0.1 (2018-04-23)

Full Changelog

Merged pull requests:

v1.0.0 (2018-03-22)

Full Changelog

Merged pull requests:

v0.6.13 (2018-03-15)

Full Changelog

Implemented enhancements:

  • Applying bins to data frames #165

Fixed bugs:

  • Sample size with an unequal split ratio #187

  • SGA Percentile Issue #178

Merged pull requests:

v0.6.12 (2018-01-24)

Full Changelog

Merged pull requests:

v0.6.11 (2018-01-23)

Full Changelog

Merged pull requests:

v0.6.10 (2018-01-12)

Full Changelog

v0.6.9 (2018-01-12)

Full Changelog

Merged pull requests:

v0.6.8 (2018-01-12)

Full Changelog

v0.6.7 (2018-01-10)

Full Changelog

Closed issues:

  • Group Sequential - Percentile Issue #176

Merged pull requests:

  • Increase version to 0.6.7 #181 (shansfolder)

  • fixed last command in “Deploying to PyPI” part of contributing.rst #180 (mkolarek)

  • Extended multiple correction for group sequential, added doc for multiple correction. #179 (daryadedik)

  • Fix information fraction calculation #177 (shansfolder)

v0.6.6 (2017-11-27)

Full Changelog

Closed issues:

  • Infinitely large confidence intervals produced by group_sequential_delta() #172

Merged pull requests:

v0.6.5 (2017-10-24)

Full Changelog

Merged pull requests:

v0.6.3 (2017-10-24)

Full Changelog

Merged pull requests:

v0.6.2 (2017-08-29)

Full Changelog

Fixed bugs:

  • Result statistics in Baeysian methods #142

Closed issues:

  • Default Parameters of Constructor of Experiment class #151

  • Update to ExpAn-Intro.ipynb #141

Merged pull requests:

v0.6.1 (2017-08-08)

Full Changelog

Implemented enhancements:

  • Optimizing the control flow from Experiment to Results #82

  • more meaningful dict keys for results #139 (gbordyugov)

Fixed bugs:

  • reenable means and bounds functions on Results object #9

Closed issues:

  • Results.to_json() implementation not flexible #65

  • Results.to_json() doesn’t support trend() results #64

Merged pull requests:

v0.6.0 (2017-07-26)

Full Changelog

Closed issues:

  • Improve binning performance #135

  • Missing unit tests for to_json() on early stopping algos #128

Merged pull requests:

v0.5.3 (2017-06-26)

Full Changelog

Implemented enhancements:

  • Weighted KPIs is only implemented in regular delta #114

Fixed bugs:

  • Assumption of nan when computing weighted KPIs #119

  • Weighted KPIs is only implemented in regular delta #114

  • Percentiles value is lost during computing group_sequential_delta #108

Closed issues:

  • Failing early stopping unit tests #85

Merged pull requests:

v0.5.2 (2017-05-11)

Full Changelog

Implemented enhancements:

Merged pull requests:

v0.5.1 (2017-04-20)

Full Changelog

Implemented enhancements:

  • Derived KPIs are passed to Experiment.fixed_horizon_delta() but never used in there #96

Merged pull requests:

v0.5.0 (2017-04-05)

Full Changelog

Implemented enhancements:

  • Bad code duplication in experiment.py #81

  • pip == 8.1.0 requirement #76

Fixed bugs:

  • Experiment.sga() assumes features and KPIs are merged in self.metrics #87

  • pctile can be undefined in Results.to\_json\(\) #78

Closed issues:

  • Results.to_json() => TypeError: Object of type ‘UserWarning’ is not JSON serializable #77

  • Rethink Results structure #66

Merged pull requests:

v0.4.5 (2017-02-10)

Full Changelog

Fixed bugs:

  • Numbers cannot appear in variable names for derived metrics #58

Merged pull requests:

v0.4.4 (2017-02-09)

Full Changelog

Implemented enhancements:

  • Add argument assume_normal and treatment_cost to calculate_prob_uplift_over_zero() and prob_uplift_over_zero_single_metric() #26

  • host intro slides (from the ipython notebook) somewhere for public viewing #10

Closed issues:

  • migrate issues from github enterprise #20

Merged pull requests:

  • Feature/results and to json refactor #71 (mkolarek)

  • new to_json() functionality and improved vim support #67 (mkolarek)

v0.4.3 (2017-02-07)

Full Changelog

Closed issues:

  • coverage % is misleading #23

Merged pull requests:

v0.4.2 (2016-12-08)

Full Changelog

Fixed bugs:

  • frequency table in the chi square test doesn’t respect the order of categories #56

Merged pull requests:

v0.4.1 (2016-10-18)

Full Changelog

Merged pull requests:

  • small doc cleanup #55 (jbao)

  • Add comments to cli.py #54 (igusher)

  • Feature/octo 545 add consolidate documentation #53 (mkolarek)

  • added os.path.join instead of manual string concatenations with ‘/’ #52 (mkolarek)

  • Feature/octo 958 outlier filtering #50 (mkolarek)

  • Sort KPIs in reverse order before matching them in the formula #49 (jbao)

v0.4.0 (2016-08-19)

Full Changelog

Closed issues:

  • Support ‘overall ratio’ metrics (e.g. conversion rate/return rate) as opposed to per-entity ratios #44

Merged pull requests:

v0.3.4 (2016-08-08)

Full Changelog

Closed issues:

  • perform trend analysis cumulatively #31

  • Python3 #21

Merged pull requests:

v0.3.3 (2016-08-02)

Full Changelog

Merged pull requests:

v0.3.2 (2016-08-02)

Full Changelog

Merged pull requests:

v0.3.1 (2016-07-15)

Full Changelog

Merged pull requests:

v0.3.0 (2016-06-23)

Full Changelog

Implemented enhancements:

  • Add P(uplift>0) as a statistic #2

  • Added function to calculate P(uplift>0) #24 (jbao)

Merged pull requests:

v0.2.5 (2016-05-30)

Full Changelog

Implemented enhancements:

  • Implement __version__ #14

Closed issues:

  • upload full documentation! #1

Merged pull requests:

v0.2.4 (2016-05-16)

Full Changelog

Closed issues:

  • No module named experiment and test_data #13

Merged pull requests:

  • new travis config specifying that only master and dev should be built #5 (mkolarek)

v0.2.3 (2016-05-06)

Full Changelog

v0.2.2 (2016-05-06)

Full Changelog

v0.2.1 (2016-05-06)

Full Changelog

v0.2.0 (2016-05-06)

Merged pull requests:

  • Added detailed documentation with data formats #3 (robertmuil)

* This Change Log was automatically generated bygithub_changelog_generator

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

expan-1.4.0.tar.gz (104.5 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page