Core library for Seldonian algorithms
Project description
Disclaimer: This repository is under active development and is not yet suitable for public use. We are currently working on an alpha release and will remove this disclaimer at the time of release.
Engine
This is the source code repository for a framework for creating and running Seldonian algorithms.
Installation
To use the latest stable version:
pip install seldonian-toolkit
To run this code as a developer, create a virtual environment. Then install the package locally, e.g.
python setup.py develop
or
pip install -e .
If you want to view the parse tree graphs using the built-in tools this library provides, install graphviz onto your system. The Seldonian library uses a Python API for graphviz, and the API requires that graphviz be installed system-wide. This should resolve mysterious error messages like "dot" not found. "dot" is a command line program included with graphviz for rendering the graphs from code.
Testing
To run the unit tests, from the command line do:
pytest
This will automatically run all tests in tests/
.
To get more introspection into the tests see the Pytest documentation.
Versioning
The naming of versions of this software adheres to semantic versioning. Pre-release versions use a major version of "0", e.g. "0.0.1" is the very first pre-release version.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for seldonian_engine-0.5.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a162b591ee5a17cac60fa2c6472f0e80c3e6792e9de99426f459b179fd653d15 |
|
MD5 | c0e90a787bd8257db93bb6b531c25d61 |
|
BLAKE2b-256 | 40ee821d50abd3cac794bf83acfef0ff3119ff9f2017eb2b7547bfe51f718505 |