Metadata-Version: 2.1
Name: cmsml
Version: 0.2.1
Summary: Python package of the CMS Machine Learning Group
Author-email: Marcel Rieger <marcel.rieger@cern.ch>
License: Copyright (c) 2020 - 2023, CMS Machine Learning Group
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice, this
          list of conditions and the following disclaimer.
        
        * Redistributions in binary form must reproduce the above copyright notice,
          this list of conditions and the following disclaimer in the documentation
          and/or other materials provided with the distribution.
        
        * Neither the name of the copyright holder nor the names of its contributors
          may be used to endorse or promote products derived from this software without
          specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
        ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
        WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Keywords: CERN,CMS,LHC,machine learning,tensorflow,keras
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: BSD License
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Information Technology
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: tabulate ~=0.9.0
Provides-Extra: dev
Requires-Dist: flake8 ~=5.0 ; extra == 'dev'
Requires-Dist: flake8-commas ~=2.1 ; extra == 'dev'
Requires-Dist: flake8-quotes ~=3.3 ; extra == 'dev'
Requires-Dist: pytest-cov >=3.0 ; extra == 'dev'
Requires-Dist: pytest-xdist ~=3.4.0 ; extra == 'dev'

<!-- marker-before-logo -->

<p align="center">
  <a href="https://github.com/cms-ml/cmsml">
    <img src="https://raw.githubusercontent.com/cms-ml/cmsml/master/logo.png" />
  </a>
</p>

<!-- marker-after-logo -->

<!-- marker-before-badges -->

<p align="center">
  <a href="https://github.com/cms-ml/cmsml/actions?query=workflow%3A%22Lint+and+test%22">
    <img alt="Lint and test" src="https://github.com/cms-ml/cmsml/workflows/Lint%20and%20test/badge.svg" />
  </a>
  <a href="https://github.com/cms-ml/cmsml/actions?query=workflow%3A%22Deploy+images%22">
    <img alt="Deploy images" src="https://github.com/cms-ml/cmsml/workflows/Deploy%20images/badge.svg" />
  </a>
  <a href="http://cmsml.readthedocs.io">
    <img alt="Documentation status" src="https://readthedocs.org/projects/cmsml/badge/?version=latest" />
  </a>
  <img alt="Python version" src="https://img.shields.io/badge/Python-%E2%89%A53.7-blue" />
  <a href="https://pypi.python.org/pypi/cmsml">
    <img alt="Package version" src="https://img.shields.io/pypi/v/cmsml.svg?style=flat" />
  </a>
  <a href="https://github.com/cms-ml/cmsml/blob/master/LICENSE">
    <img alt="License" src="https://img.shields.io/github/license/cms-ml/cmsml.svg" />
  </a>
</p>

<!-- marker-after-badges -->

<!-- marker-before-header -->

## CMS Machine Learning Group Python package.

The documentation of this Python package is hosted on [readthedocs](http://cmsml.readthedocs.io).

**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](https://cms-ml.github.io/documentation).

Click [here](https://github.com/cms-ml/cmsml/issues/new?labels=suggestion&template=feature-suggestion.md&) to submit a feature suggestion!


<!-- marker-after-header -->

<!-- marker-before-body -->

<!-- marker-before-docker -->

## Docker images

To use the cmsml package via docker, checkout our [DockerHub](https://hub.docker.com/repository/docker/cmsml/cmsml) which contains tags for several Python versions.

<!-- marker-after-docker -->

<!-- marker-before-testing -->

## Testing

The tests can be triggered with

```shell
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

```shell
# 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](https://www.python.org/dev/peps/pep-0008) compatibility should be checked with [flake8](https://pypi.org/project/flake8) via

```shell
./tests/lint.sh
```

or using the docker container

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

<!-- marker-after-testing -->

<!-- marker-before-development -->

- Source hosted at [GitHub](https://github.com/cms-ml/cmsml)
- Report issues, questions, feature requests on [GitHub Issues](https://github.com/cms-ml/cmsml/issues)

<!-- marker-after-development -->

<!-- marker-after-body -->
