Skip to main content

A Python library for working with A/B tests.

Project description

PyPI PyPI License ReadTheDocs Tests Coverage Black Python Versions Telegram Channel

https://raw.githubusercontent.com/MobileTeleSystems/Ambrosia/main/docs/source/_static/ambrosia.png

Ambrosia is a Python library for A/B tests design, split and effect measurement. It provides rich set of methods for conducting full A/B testing pipeline.

The project is intended for use in research and production environments based on data in pandas and Spark format.

Key functionality

  • Pilots design 🛫

  • Multi-group split 🎳

  • Matching of new control group to the existing pilot 🎏

  • Experiments result evaluation as p-value, point estimate of effect and confidence interval 🎞

  • Data preprocessing ✂️

  • Experiments acceleration 🎢

Documentation

For more details, see the Documentation and Tutorials.

Installation

You can always get the newest Ambrosia release using pip. Stable version is released on every tag to main branch.

pip install ambrosia

Starting from version 0.4.0, the ability to process PySpark data is optional and can be enabled using pip extras during the installation.

pip install ambrosia[spark]

Usage

The main functionality of Ambrosia is contained in several core classes and methods, which are autonomic for each stage of an experiment and have very intuitive interface.


Below is a brief overview example of using a set of three classes to conduct some simple experiment.

Designer

from ambrosia.designer import Designer
designer = Designer(dataframe=df, effects=1.2, metrics='portfel_clc') # 20% effect, and loaded data frame df
designer.run('size')

Splitter

from ambrosia.splitter import Splitter
splitter = Splitter(dataframe=df, id_column='id') # loaded data frame df with column with id - 'id'
splitter.run(groups_size=500, method='simple')

Tester

from ambrosia.tester import Tester
tester = Tester(dataframe=df, column_groups='group') # loaded data frame df with groups info 'group'
tester.run(metrics='retention', method='theory', criterion='ttest')

Development

To install all requirements run

make install

You must have python3 and poetry installed.

For autoformatting run

make autoformat

For linters check run

make lint

For tests run

make test

For coverage run

make coverage

To remove virtual environment run

make clean

Authors

Developers and evangelists:

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

ambrosia-0.5.0.tar.gz (84.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ambrosia-0.5.0-py3-none-any.whl (121.3 kB view details)

Uploaded Python 3

File details

Details for the file ambrosia-0.5.0.tar.gz.

File metadata

  • Download URL: ambrosia-0.5.0.tar.gz
  • Upload date:
  • Size: 84.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.2 CPython/3.11.14 Linux/6.11.0-1018-azure

File hashes

Hashes for ambrosia-0.5.0.tar.gz
Algorithm Hash digest
SHA256 4fb3d913f2572bed7d292857b0d69a0b7e3b252cb1d532915bed0e1e44dd4fc6
MD5 c6b9b00d6de2061e6436e5efeac3fdbb
BLAKE2b-256 9e2104fc05765a7a6ef5ec4b76d8fa64da8197a5331cdbf18ac5740c95dd61e8

See more details on using hashes here.

File details

Details for the file ambrosia-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: ambrosia-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 121.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.2 CPython/3.11.14 Linux/6.11.0-1018-azure

File hashes

Hashes for ambrosia-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d11c79f74e5efc9008b84f791c00584a6ff582db17036c1e0a6447a4374503ef
MD5 4e964764f5d9aff6a5ffb7a95d189ecf
BLAKE2b-256 114111a5f339a02bdc435b40cfcf197580780c819acd9c0736b54712abdbb6a4

See more details on using hashes here.

Supported by

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