Skip to content

Package Virne CLI and configs - #55

Merged
GeminiLight merged 1 commit into
mainfrom
agent/package-cli
Aug 12, 2026
Merged

Package Virne CLI and configs#55
GeminiLight merged 1 commit into
mainfrom
agent/package-cli

Conversation

@GeminiLight

Copy link
Copy Markdown
Owner

Summary

  • add an installed virne console command and python -m virne entry point while retaining python main.py compatibility
  • move the unchanged Hydra defaults into virne/configs/ and include every YAML preset in wheels and source distributions
  • make top-level package exports lazy so virne --version does not load the full PyTorch and solver stack
  • build and install the wheel in CI before testing its metadata, resources, help/config output, and a ten-request experiment
  • update the README and documentation to make the standard PyPI flow primary and keep the source installer for explicit CPU/CUDA selection

Why

The repository declared version 1.0.0, but its wheel did not include the top-level runner or settings/ directory and exposed no console script. Uploading that artifact would therefore install the library without a self-contained benchmark command. The only public PyPI release remains the outdated 0.5.0 package.

User impact

After the separately approved 1.0.0 release, users can run:

python -m pip install virne
virne solver.solver_name=nrm_rank

Source users can continue to use python main.py, and accelerator-specific installs can continue to use install.sh.

Validation

  • 263 tests passed on Python 3.12 and Python 3.13
  • fresh wheel installs passed pip check, metadata/resource checks, virne --help, virne --version, and python -m virne --cfg job
  • the final wheel completed the ten-request nrm_rank smoke experiment on both Python versions
  • all 13 moved YAML files are byte-for-byte identical to their previous source files
  • wheel and sdist builds succeeded and both passed twine check
  • strict Sphinx build passed with warnings treated as errors
  • focused Ruff checks, warning-as-error compilation, uv lock --check, shell syntax, and diff checks passed

Release boundary

This PR does not publish to PyPI. Trusted Publishing configuration, the release workflow, and the immutable 1.0.0 upload remain a separate approval step after this packaging PR is reviewed.

@GeminiLight
GeminiLight marked this pull request as ready for review August 12, 2026 10:47
@GeminiLight
GeminiLight merged commit 2081e44 into main Aug 12, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant