Metadata-Version: 2.1
Name: ssrm-test
Version: 0.1.1
Summary: A library for Bayesian Sequential Sample Ratio Mismatch (SRM) test.
Home-page: https://github.com/optimizely/ssrm
Author: Michael Lindon
Author-email: michael.lindon@optimizely.com
Requires-Python: >=3.6,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: numpy (>=1.16,<2.0)
Requires-Dist: scipy (>=1.3,<2.0)
Requires-Dist: toolz (>=0.10.0,<0.11.0)
Requires-Dist: typing (>=3.7.4,<4.0.0)
Project-URL: Repository, https://github.com/optimizely/ssrm
Description-Content-Type: text/markdown

![Build](https://github.com/optimizely/ssrm/workflows/Build/badge.svg)

# Sequential Sample Ratio Mismatch (SRM) test.
A package for sequential testing of Sample Ratio Mismatch (SRM).

Contributors:
- Michael Lindon (michael.lindon@optimizely.com )

## Installation
We recommend that you use an isolated virtual environment to install and run the code in this repo (See: [virtualenv](https://pypi.org/project/virtualenv/) and [pyenv](https://github.com/pyenv/pyenv))

1. Install dependencies: Run `make install`.
    - If you wish to develop in the repo, run `make
    install-dev`.  Also, see the contributing doc [here](/CONTRIBUTING.md)
    > **Tip:** have a look in the [`Makefile`](/Makefile) to learn more about what this, and other make recipes do!
1. Run tests:
    -   `make check` to run all checks.
    -   `make test` to run unit tests.


## Tutorials
We provide a tutorial notebook that walks through an example of running a Sequential SRM test here.

## Documentation
The latest reference documentation is here.

## Contributing
See the contributing doc [here](/CONTRIBUTING.md).

