Metadata-Version: 2.1
Name: mead-xpctl
Version: 1.1.0
Summary: Experiment Control and Tracking
Home-page: https://www.github.com/mead-ml/xpctl
Author: mead-ml
Author-email: mead.baseline@gmail.com
License: Apache 2.0
Keywords: experiment control,tracking
Platform: UNKNOWN
Classifier: Natural Language :: English
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Programming Language :: Python :: 3.6
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 2.7
Description-Content-Type: text/markdown
Requires-Dist: Click
Requires-Dist: click-shell
Requires-Dist: pandas
Requires-Dist: xlsxwriter
Requires-Dist: jsondiff
Requires-Dist: pyyaml
Requires-Dist: certifi (>=14.05.14)
Requires-Dist: six (>=1.10)
Requires-Dist: python-dateutil (>=2.5.3)
Requires-Dist: setuptools (>=21.0.0)
Requires-Dist: urllib3 (>=1.15.1)
Provides-Extra: mongo
Requires-Dist: pymongo ; extra == 'mongo'
Provides-Extra: sql
Requires-Dist: sqlalchemy ; extra == 'sql'
Requires-Dist: psycopg2 ; extra == 'sql'
Provides-Extra: test

## XPCTL

`xpctl` is software to track experimental results and provide access to a global leaderboard. After running an experiment, the results and the logs are committed to a database. Several commands are provided to show the best experimental results under various constraints.

`xpctl` was developed as the primary backend for experiment storage for [mead-baseline](https://github.com/dpressel/mead-baseline/).

### Prerequisite

`xpctl` requires a database to be installed locally or an accessible server. We currently support:  [mongodb](https://docs.mongodb.com/) and [postgresql](https://www.postgresql.org/)), but the base classes can be extended to support other databases. Create a database called `reporting_db` in your db instance.


### Installation

-  [Install the server](https://github.com/mead-ml/xpctl/blob/master/orchestration/README.md)
-  Install the client
  - `pip install mead-xpctl`
  - or locally with `pip install -e .`

### [Documentation](https://github.com/mead-ml/xpctl/blob/master/docs/main.md)


