Release v1.1.6

Release v1.1.6 - Change Log

October 2024

Added

• Imported the FourPeaksGenerator class.
• Added pr_agent.yml for CI workflow automation.

Improvements

• Enhanced/Fixed Algorithm Callback Functions

  • Enforced that callback_user_info parameters are of type dict across all algorithm functions (genetic_alg, gradient_descent, hill_climb, mimic, random_hill_climb, simulated_annealing). This ensures consistent and predictable callback behavior.
  • Increased exception coverage by adding type checks and raising TypeError when callback_user_info is not a dict.
  • Refactored code to replace list-based user_data with dictionary-based callback_user_info for better data management and clarity.
  • Updated type hints and documentation to reflect these changes, improving code readability and maintainability.
  • Added comprehensive unit tests to validate the new type enforcement and ensure robust error handling.

• Achieved 100% test coverage across multiple algorithms and modules.

• Enhanced documentation, including updated README.md with new badges and clearer descriptions.

• Refactored code for better organization, readability, and improved type hints.

Fixes

• Corrected coverage and PyPi badge URLs in README.md.
• Fixed known bugs in skmlp_runner.py.

Removed

• Eliminated the RESTARTS parameter from the .algorithms.hc module.

---

Full Changelog: mlrose-ky-v1.1.5...mlrose-ky-v1.1.6