Skip to main content

Python package of the CMS Machine Learning Group

Project description

Lint and test Deploy images Documentation status Python version 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!

Docker images

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

Image Python version TF Version PyTorch Version GPU support
cmsml/cmsml:3.7 3.7 2.11.1 1.13.1
cmsml/cmsml:3.8 3.8 2.13.1 latest (~2.3.0)
cmsml/cmsml:3.9
cmsml/cmsml:3
cmsml/cmsml:latest
3.9 latest (~2.16.1) latest (~2.3.0)
cmsml/cmsml:3.10 3.10 latest (~2.16.1) latest (~2.3.0)
cmsml/cmsml:3.11 3.11 latest (~2.16.1) latest (~2.3.0)
cmsml/cmsml:3.11-cuda 3.11 latest (~2.16.1) latest (~2.3.0) ✔︎

Testing

The tests can be triggered with

pytest -n auto tests

and in general, they should be run for Python 3.7 to 3.11. 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 via

./tests/lint.sh

or using the docker container

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

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

cmsml-0.2.7.tar.gz (24.1 kB view details)

Uploaded Source

Built Distribution

cmsml-0.2.7-py3-none-any.whl (26.2 kB view details)

Uploaded Python 3

File details

Details for the file cmsml-0.2.7.tar.gz.

File metadata

  • Download URL: cmsml-0.2.7.tar.gz
  • Upload date:
  • Size: 24.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for cmsml-0.2.7.tar.gz
Algorithm Hash digest
SHA256 d02d46e46119f4c1f21e476c034e80cc39671bf73766f4ea20087eaec1605b82
MD5 aee4b3efeb714ef4c8094774911e1334
BLAKE2b-256 91a7b366f71cb19abe35fe6cc8ef36498e55300b5f881366862a78371f4438f4

See more details on using hashes here.

Provenance

File details

Details for the file cmsml-0.2.7-py3-none-any.whl.

File metadata

  • Download URL: cmsml-0.2.7-py3-none-any.whl
  • Upload date:
  • Size: 26.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for cmsml-0.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 2c1d379533c20fc40c791f4a4680a0f6c4cb1f937a0f8de49c4162622f52f69c
MD5 7543b3670e5ce71e3bb670bd4fe382df
BLAKE2b-256 9f8409c3dd9f59ec2af62f158e26503b8936f50593aab8ccdec5605ecca53c89

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page