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

Requirements: Python 3.9+

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.1.tar.gz (86.4 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.1-py3-none-any.whl (122.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ambrosia-0.5.1.tar.gz
  • Upload date:
  • Size: 86.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.2 CPython/3.11.15 Linux/6.14.0-1017-azure

File hashes

Hashes for ambrosia-0.5.1.tar.gz
Algorithm Hash digest
SHA256 7ea7c47e8aa089b5e61d3e0c5f3a681cb563c5af7d54631b123e9e77cbd98df4
MD5 ca75184f7ee8fa133344c581230f1382
BLAKE2b-256 b74787a66090145be777899560454d5398ccf56c3e0e34ccea121fd836ce4ba2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ambrosia-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 122.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.2 CPython/3.11.15 Linux/6.14.0-1017-azure

File hashes

Hashes for ambrosia-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f8ca235e2682665539951571c61e3cde03d8bf24eeab19e5df74f3d1ac9e5c5e
MD5 7e093c9398c65711f17e13ce9a21c8ba
BLAKE2b-256 b5ecc2c0e1f77d32d021cd4e39ffa794793dc756c15e4f885835fbaec42280fd

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