cmsml logo
Lint and test Deploy images Documentation status Package version License

CMS Machine Learning Group Python package

The documentation of this Python package is hosted on readthedocs.

However, note that this documentation only covers the API and technical aspects of the package itself. Usage examples and further techniques for working with machine learning tools in CMS, alongside a collection of useful guidelines can be found in the general CMS ML group documentation.

Click here to submit a feature suggestion!

Table of contents

Docker images

To use the cmsml package via docker, checkour our DockerHub which contains tags for several Python versions.

Testing

The tests can be triggered with

python -m unittest tests

and in general, they should be run for Python 2.7, 3.7 and 3.8. To run tests in a docker container, do

# run the tests
./tests/docker.sh cmsml/cmsml

# or interactively by adding a flag "i" to the command
./tests/docker.sh cmsml/cmsml i
> python -m unittest tests

In addition, before pushing to the repository, PEP 8 compatibility should be checked with flake8

./tests/lint.sh

or via using the docker container

# run the tests
./tests/docker.sh cmsml/cmsml tests/lint.sh

Development