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

Release v1.1.5

View the latest release on PyPi: https://pypi.org/project/mlrose-ky/1.1.5/

What's Changed

• Fixed docs and added new NeuralNetwork() example by @nkapila6 in #19
• Update tutorial1.md by @zerolinux5 in #16

New Contributors

• @zerolinux5 made their first contribution in #16

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

Release v1.1.4

https://pypi.org/project/mlrose-ky/1.1.4/

What's Changed

• docs: added contrib section in root README.md by @nkapila6 in #2
• some updates: updated actions workflow to reflect code coverage, updating docs by @nkapila6 in #4
• Restore Class Names in decay and mutators Folders for Backward Compatibility by @gitongah in #9
• Renamed the two classes the traveling sales and the synthetic data. by @gitongah in #12
• Feat/revert all method names for backwards compatibility by @knakamura13 in #14

New Contributors

• @gitongah made their first contribution in #9
• @knakamura13 made their first contribution in #14

Full Changelog: mlrose-ky-v1.0.0...mlrose-ky-v1.1.4

Release mlrose-ky v1.0.0 to PyPi

Published the first version of mlrose-ky to PyPi 🥳

https://pypi.org/project/mlrose-ky/1.0.0/

What's Changed

• docs: initial addition of documentation by @nkapila6 in #1

Full Changelog: https://github.com/knakamura13/mlrose-ky/commits/mlrose-ky-v1.0.0