Repository navigation
v0.0.4
What's Changed
Updates the documentation and code to reflect a major change in the genetic algorithm's parent selection method, moving from "feasible-elite" to a more balanced "elite-slice" approach. It also removes the magnitude penalty parameter from both the documentation and the code, updates the software version to 0.0.4, and improves citation metadata. Several unused or redundant code sections have been cleaned up for maintainability.
Genetic algorithm and documentation updates
- Updated the genetic algorithm's parent selection method from "feasible-elite" to "elite-slice", emphasizing a balanced secondary ranking that considers flow-fit error, reliability, and demand magnitude. All related documentation, including the README.md and docstrings, has been revised for clarity.
- Removed the magnitude_penalty parameter from both the CLI documentation and the optimizer code; the magnitude_penalty_weight argument is now deprecated and unused.
- Updated and clarified GA parameter descriptions and removed unused OD candidate arguments from documentation.
Citation and metadata improvements
- Added a CITATION.cff file for canonical citation metadata and updated the version and year in citation examples to 0.0.4. The old BibTeX citation file was removed.
Code maintenance and cleanup
- Updated package version to 0.0.4 in init.py and citation examples.
- Removed unused imports and redundant methods from demandify/cache/manager.py, including load_metadata and get_stats.
- Minor cleanup in main.py (removed unused import).
Internal optimizer improvements
- Refactored tracking of the best individual in the optimizer to provide more detailed metrics and added a utility for raw loss extraction.
These changes improve the clarity, maintainability, and usability of the package, especially regarding the genetic algorithm's behavior and user-facing documentation.
Full Changelog: v0.0.3...v0.0.4