Repository navigation
Prepare the release: licenses, metadata, legacy modules, HPO smoke tests - #34
Merged
Merged
Conversation
Licenses: LICENSE.md is the MIT license of KoopmanRL alone, so that it is detected as MIT. The third-party texts move to LICENSES/: CleanRL's MIT license, and the LGPL-3.0 of the observables adapted from d3s together with the GPL-3.0 it supplements, which was missing. LICENSES/README.md says which file is under which license (the list named a file that does not exist). The three d3s-derived files carry SPDX headers, and pyproject, CITATION.cff and .zenodo.json declare MIT AND LGPL-3.0-only. Metadata: * .zenodo.json: title KoopmanRL; the related identifier pointed to a repository that does not exist and now names arXiv:2403.02290. * CITATION.cff: date-released is today. * pyproject.toml: `repository` was not a valid [project] key, so the package had no project URLs; they are in [project.urls]. Development status 3 - Alpha. Preston Rozwood's email as in CITATION.cff. Legacy modules removed: koopmanrl/interpretability_discrete_value_iteration.py (imported a module `analysis` that does not exist) and koopmanrl_utils/plot_csv_from_tensorboards.py (hard-coded 2024 run names, a "TODO: Debug", undeclared pandas). Neither was used. test_hparam_opt is a smoke test: one single-sample study on one CPU core per algorithm, on the linear system by default; the other environments carry the hpo_full marker, deselected by default. Ray's temporary directory is a short directory under /tmp, so the tests also run on macOS. README: in a virtual environment set up with `uv pip install .`, commands run with `python -m`, since `uv run` would re-sync the environment. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes from the final release audit, in one PR.
1. Licenses
LICENSE.mdis now the MIT license of KoopmanRL alone, so GitHub detects it as MIT instead of "Other".LICENSES/holds the third-party texts:MIT-CleanRL.txt;LGPL-3.0-only.txt, for the observables adapted from d3s, whose repository is LGPL-3.0;GPL-3.0-only.txt, the text the LGPL supplements. It was missing before. Both GNU texts are verbatim from gnu.org.LICENSES/README.mdsays which file is under which license. The old list namedvalue_function_continuous_action.py, which does not exist.LGPL-3.0-only) are added tokoopmanrl/koopman_observables.pyandkoopmanrl/koopman_tensor/observables/{numpy,torch}_observables.py. The first and last stay identical.pyproject.toml:license = "MIT AND LGPL-3.0-only", pluslicense-files. The built wheel ships all four license files.CITATION.cff:license: [MIT, LGPL-3.0-only]..zenodo.json: keeps"license": "MIT", since a Zenodo deposit takes one license, and its description now names the LGPL part.README.md: a new License section.2–4. Citation metadata
.zenodo.json:titleis nowKoopmanRL.github.com/dynamicslab/koopman-rl, which does not exist. It now points toarXiv:2403.02290(isSupplementTo, schemearxiv).CITATION.cff:date-released: 2026-10-10.5–7.
pyproject.tomlrepositoryis not a valid[project]key, so the built package carried no project URLs. They now live in[project.urls]: Repository, Documentation and Paper.Development Status :: 2 - Pre-Alphabecomes3 - Alpha.pwr@cornell.edu, as inCITATION.cff.8. Legacy modules removed
These two modules were broken and no longer used:
koopmanrl/interpretability_discrete_value_iteration.pyimported a moduleanalysisthat does not exist, so it could not even be imported.koopmanrl_utils/plot_csv_from_tensorboards.pyhad hard-coded 2024 run names and a "TODO: Debug", and used pandas, which is not a declared dependency.The docs API table and the two
AGENTS.mdtrees no longer list them.9. Hyperparameter-optimization tests are smoke tests
tests/test_hparam_opt.py:--num_samples=1,--max_concurrent=1and--cpu_cores_per_trial=1. Before, it requested 16 cores per trial, so on smaller machines it hung until the 600 s timeout.LinearSystem-v0runs: one study per algorithm, about 1.5 minutes.hpo_full, whichaddoptsinpyproject.tomldeselects. Run them withuv run pytest tests/test_hparam_opt.py -m hpo_full, or everything with-m ""./tmp, removed afterwards. With pytest'stmp_path, Ray's AF_UNIX socket paths exceeded the macOS limit, so these tests could not run on macOS at all. They now do.tests/AGENTS.md, the rootAGENTS.mdanddocs/docs/developers/contributing.mddescribe the new behaviour.10. README: the
uv rungapAfter the alternative setup (
uv venv+uv pip install .), the README went on withuv run ..., which re-syncs the environment to the lock file and so replaces theuv pip install .. The first-run example now shows both forms,uv run -mafteruv syncandpython -min the activated environment, and a note explains the difference.11. Merged branches
The 14 fully merged branches on GitHub have been deleted (each was checked to be an ancestor of
main). Onlymainand this PR's branch remain.Test plan
uv run pytest: 282 passed, 6 deselected (hpo_full), in 4 min 14 suv run pytest tests/test_hparam_opt.py: 2 passed in 90 s, on macOS with 16 coresuv run pytest tests/test_hparam_opt.py -m hpo_full: 6 passed in 4 min 45 suv run pre-commit run --all-filesuv lock --checkcffconvert --validatejson.toolon.zenodo.jsonvalidate-pyprojectuv build: the wheel METADATA hasLicense-Expression: MIT AND LGPL-3.0-only, fourLicense-Files, threeProject-URLs,3 - Alpha, and the corrected emailcd docs && npm ci && npm run build🤖 Generated with Claude Code