cmsml

Name	cmsml JSON
Version	0.2.5 JSON
	download
home_page	None
Summary	Python package of the CMS Machine Learning Group
upload_time	2024-03-27 15:09:47
maintainer	None
docs_url	None
author	None
requires_python	>=3.7
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
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            <!-- 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 -->

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "cmsml",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "CERN, CMS, LHC, machine learning, tensorflow, keras",
    "author": null,
    "author_email": "Marcel Rieger <marcel.rieger@cern.ch>",
    "download_url": "https://files.pythonhosted.org/packages/2d/af/727ad75b2a4ed99c2f7cc445d51f2b16d05d7a9834a7da265eb21c22422a/cmsml-0.2.5.tar.gz",
    "platform": null,
    "description": "<!-- marker-before-logo -->\n\n<p align=\"center\">\n  <a href=\"https://github.com/cms-ml/cmsml\">\n    <img src=\"https://raw.githubusercontent.com/cms-ml/cmsml/master/logo.png\" />\n  </a>\n</p>\n\n<!-- marker-after-logo -->\n\n<!-- marker-before-badges -->\n\n<p align=\"center\">\n  <a href=\"https://github.com/cms-ml/cmsml/actions?query=workflow%3A%22Lint+and+test%22\">\n    <img alt=\"Lint and test\" src=\"https://github.com/cms-ml/cmsml/workflows/Lint%20and%20test/badge.svg\" />\n  </a>\n  <a href=\"https://github.com/cms-ml/cmsml/actions?query=workflow%3A%22Deploy+images%22\">\n    <img alt=\"Deploy images\" src=\"https://github.com/cms-ml/cmsml/workflows/Deploy%20images/badge.svg\" />\n  </a>\n  <a href=\"http://cmsml.readthedocs.io\">\n    <img alt=\"Documentation status\" src=\"https://readthedocs.org/projects/cmsml/badge/?version=latest\" />\n  </a>\n  <img alt=\"Python version\" src=\"https://img.shields.io/badge/Python-%E2%89%A53.7-blue\" />\n  <a href=\"https://pypi.python.org/pypi/cmsml\">\n    <img alt=\"Package version\" src=\"https://img.shields.io/pypi/v/cmsml.svg?style=flat\" />\n  </a>\n  <a href=\"https://github.com/cms-ml/cmsml/blob/master/LICENSE\">\n    <img alt=\"License\" src=\"https://img.shields.io/github/license/cms-ml/cmsml.svg\" />\n  </a>\n</p>\n\n<!-- marker-after-badges -->\n\n<!-- marker-before-header -->\n\n## CMS Machine Learning Group Python package.\n\nThe documentation of this Python package is hosted on [readthedocs](http://cmsml.readthedocs.io).\n\n**However**, note that this documentation only covers the API and technical aspects of the package itself.\nUsage 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).\n\nClick [here](https://github.com/cms-ml/cmsml/issues/new?labels=suggestion&template=feature-suggestion.md&) to submit a feature suggestion!\n\n\n<!-- marker-after-header -->\n\n<!-- marker-before-body -->\n\n<!-- marker-before-docker -->\n\n## Docker images\n\nTo use the cmsml package via docker, checkout our [DockerHub](https://hub.docker.com/repository/docker/cmsml/cmsml) which contains tags for several Python versions.\n\n<!-- marker-after-docker -->\n\n<!-- marker-before-testing -->\n\n## Testing\n\nThe tests can be triggered with\n\n```shell\npytest -n auto tests\n```\n\nand in general, they should be run for Python 3.7 to 3.11.\nTo run tests in a docker container, do\n\n```shell\n# run the tests\n./tests/docker.sh cmsml/cmsml\n\n# or interactively by adding a flag \"i\" to the command\n./tests/docker.sh cmsml/cmsml i\n> python -m unittest tests\n```\n\nIn 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\n\n```shell\n./tests/lint.sh\n```\n\nor using the docker container\n\n```shell\n# run the tests\n./tests/docker.sh cmsml/cmsml tests/lint.sh\n```\n\n<!-- marker-after-testing -->\n\n<!-- marker-before-development -->\n\n- Source hosted at [GitHub](https://github.com/cms-ml/cmsml)\n- Report issues, questions, feature requests on [GitHub Issues](https://github.com/cms-ml/cmsml/issues)\n\n<!-- marker-after-development -->\n\n<!-- marker-after-body -->\n",
    "bugtrack_url": null,
    "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. ",
    "summary": "Python package of the CMS Machine Learning Group",
    "version": "0.2.5",
    "project_urls": null,
    "split_keywords": [
        "cern",
        " cms",
        " lhc",
        " machine learning",
        " tensorflow",
        " keras"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "955949f6c8bd8c07a9ef20198fa8e59ef914842229bd3ba38e0849be91286bae",
                "md5": "466e6b7a180fee09cbf9d3c07f263478",
                "sha256": "29ba2e81652589f8e72f6348c1d2534b07073d9b726e28f8f5111f71e13f67e0"
            },
            "downloads": -1,
            "filename": "cmsml-0.2.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "466e6b7a180fee09cbf9d3c07f263478",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 25267,
            "upload_time": "2024-03-27T15:09:46",
            "upload_time_iso_8601": "2024-03-27T15:09:46.116626Z",
            "url": "https://files.pythonhosted.org/packages/95/59/49f6c8bd8c07a9ef20198fa8e59ef914842229bd3ba38e0849be91286bae/cmsml-0.2.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2daf727ad75b2a4ed99c2f7cc445d51f2b16d05d7a9834a7da265eb21c22422a",
                "md5": "4b79ac1f69cfe038373a121535c69e04",
                "sha256": "82f9028d429a1249e7b96c5ec0e2ee4f60ad4ef2d4d75b61e0f5fddcd1bf15c2"
            },
            "downloads": -1,
            "filename": "cmsml-0.2.5.tar.gz",
            "has_sig": false,
            "md5_digest": "4b79ac1f69cfe038373a121535c69e04",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 22877,
            "upload_time": "2024-03-27T15:09:47",
            "upload_time_iso_8601": "2024-03-27T15:09:47.794931Z",
            "url": "https://files.pythonhosted.org/packages/2d/af/727ad75b2a4ed99c2f7cc445d51f2b16d05d7a9834a7da265eb21c22422a/cmsml-0.2.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-27 15:09:47",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "cmsml"
}