Metadata-Version: 2.4
Name: cernml-rltools
Version: 0.12.1
Summary: Utilities for RL as part of the Geoff project
Author-email: Penny Madysa <penny.madysa@cern.ch>
License: Except as otherwise noted (below and/or in individual files), this work is
        licensed under either of GNU Public License, Version 3.0 or later
        <LICENSES/GPL-3.0-or-later.txt>, or European Union Public License, Version 1.2
        or later <LICENSES/EUPL-1.2.txt>, at your option.
        
        Unless You explicitly state otherwise, any contribution intentionally submitted
        by You for inclusion in this Work (the Covered Work) shall be dual-licensed as
        above, without any additional terms or conditions.
        
        For full authorship information, see the version control history.
        
Project-URL: Homepage, https://geoff.docs.cern.ch/
Project-URL: Download, https://gitlab.cern.ch/geoff/cernml-rltools/-/releases
Project-URL: Documentation, https://geoff.docs.cern.ch/cernml-rltools/
Project-URL: Internal Documentation Mirror, https://acc-py.web.cern.ch/gitlab/geoff/cernml-rltools/
Project-URL: Source Code, https://gitlab.cern.ch/geoff/cernml-rltools
Project-URL: Bug Tracker, https://gitlab.cern.ch/geoff/cernml-rltools/-/work_items
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
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: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Typing :: Typed
Description-Content-Type: text/markdown
License-File: COPYING
Requires-Dist: cernml-coi-utils[matplotlib]>=0.3
Requires-Dist: importlib-metadata; python_version < "3.10"
Requires-Dist: typing-extensions
Requires-Dist: numpy>=1
Provides-Extra: test
Requires-Dist: click; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Provides-Extra: doc
Requires-Dist: click; extra == "doc"
Requires-Dist: types-docutils; extra == "doc"
Requires-Dist: types-urllib3; extra == "doc"
Requires-Dist: python-docs-theme; extra == "doc"
Requires-Dist: sphinx; extra == "doc"
Dynamic: license-file

<!--
SPDX-FileCopyrightText: 2020-2026 CERN
SPDX-FileCopyrightText: 2023-2026 GSI Helmholtzzentrum für Schwerionenforschung
SPDX-FileNotice: All rights not expressly granted are reserved.

SPDX-License-Identifier: GPL-3.0-or-later OR EUPL-1.2+
-->

CERNML RL Tools
===============

This is a collection of useful classes and functions for machine learning that
have come up repeatedly while implementing automated control for the [AWAKE][]
experiment.

A strong effort is made to keep these helpers neutral w.r.t. the ML framework
that one uses (TensorFlow, PyTorch, Theano, etc.). Merge requests are welcome
whenever it is likely that a class or function is useful to multiple projects
and there is a benefit to having one central implementation.

The repository is available on CERN's [Gitlab][].

[AWAKE]: https://awake.web.cern.ch/
[Gitlab]: https://gitlab.cern.ch/geoff/cernml-rltools

Requirements
------------

This package only requires [NumPy][], [Matplotlib][] and [Gymnasium][],
as well as the [Common Optimization Interfaces][COI]. For details, see
[pyproject.toml].

[NumPy]: https://numpy.org/
[Matplotlib]: https://matplotlib.org/
[Gymnasium]: https://gymnasium.farama.org/
[COI]: https://gitlab.cern.ch/geoff/cernml-coi/
[pyproject.toml]: /pyproject.toml

License
-------

Except as otherwise noted, this work is licensed under either of [GNU Public
License, Version 3.0 or later](LICENSES/GPL-3.0-or-later.txt), or [European
Union Public License, Version 1.2 or later](LICENSES/EUPL-1.2.txt), at your
option. See [COPYING](COPYING) for details.

Unless You explicitly state otherwise, any contribution intentionally submitted
by You for inclusion in this Work (the Covered Work) shall be dual-licensed as
above, without any additional terms or conditions.

For full authorship information, see the version control history.
