Repository navigation
Correct the README's install and HPO instructions, and the citation metadata - #23
Merged
Merged
Conversation
…etadata README: * Show the clone command; the clone directory is KoopmanRL, not koopman-rl. * `uv venv --python 3.10 && uv venv` created the environment twice; activate it instead. * The HPO examples could not finish elsewhere: --storage_dir defaults to a path on the authors' machine, where the best configuration is written at the end of the study, and --cpu_cores_per_trial defaults to 28, which Ray cannot schedule on a smaller machine. The examples now set both. * Name SAKC as the package does (Soft Actor Koopman-Critic), link the documentation site, list generate_tensor and its --regressor option, and mention the three reproduction JSON files in configurations/. * Add a Citation section (arXiv:2403.02290). CITATION.cff: * Wen Sun's given and family names were swapped (twice). * `url` pointed to github.com/dynamicslabs (typo); it now points to the documentation site. * The paper reference failed schema validation (`journal` must be a string); it now cites the arXiv preprint. `cffconvert --validate` passes. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2 tasks done
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
1 participant
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
A pass over
README.mdandCITATION.cffafter #15–#22.README
cd koopman-rlnames the wrong directory: the repository clones asKoopmanRL.uv venv --python 3.10 && uv venvrecreated.venva second time. It now activates the environment instead.--storage_dirdefaults to/home/lpaehler/..., and the best configuration is written there only at the end of the study (skvi_optuna_opt.py:126,sakc_optuna_opt.py:114).--cpu_cores_per_trialdefaults to 28, and Ray cannot schedule a trial that asks for more cores than the machine has.configurations/: Soft Actor Koopman-Critic.koopmanrl.koopman_tensor.generate_tensorwith--regressor, the three reproduction JSON files inconfigurations/, and a Citation section for arXiv:2403.02290 (title and authors checked against arXiv).CITATION.cff
urlpointed togithub.com/dynamicslabs/...(a typo). It now points to the documentation site.references[0].journalwas{name: tbd}), which breaks GitHub's "Cite this repository". The reference now cites the arXiv preprint.Not in this PR
--storage_dirinkoopmanrl/{skvi,sakc}_optuna_opt.pyis a code issue. This PR only documents how to work around it.AGENTS.mdfiles get their own PRs.Test plan
uv run -m <module> --helpresolves, and the flags exist.uvx --from cffconvert cffconvert --validate: valid. It failed before this change.uv run pre-commit run --files README.md CITATION.cff🤖 Generated with Claude Code