knakamura13 / mlrose-ky

A highly optimized fork of the popular mlrose-hiive package. For Machine Learning, Randomized Optimization and SEarch algorithms.
https://nkapila6.github.io/mlrose-ky/
BSD 3-Clause "New" or "Revised" License
20 stars 8 forks source link

Restore Class Names in decay and mutators Folders for Backward Compatibility #9

Closed gitongah closed 2 months ago

gitongah commented 2 months ago

This pull request addresses the renaming of classes in the decay and mutators folders to their original names, ensuring backward compatibility with existing codebases that rely on these class names.

knakamura13 commented 2 months ago

I think the CI tests failed because the class names like GeometricDecay need to be removed from the __init__.py files and the new names need to be added to those files.

github-actions[bot] commented 2 months ago

Coverage report

Click to see where and how coverage changed

FileStatementsMissingCoverageCoverage
(new stmts)
Lines missing
  src/mlrose_ky
  __init__.py
  src/mlrose_ky/algorithms
  __init__.py
  sa.py
  src/mlrose_ky/algorithms/decay
  __init__.py
  arithmetic_decay.py 67
  custom_decay.py 37, 43
  exponential_decay.py 69
  geometric_decay.py 67
  src/mlrose_ky/algorithms/mutators
  __init__.py
  _mutator_base.py
  discrete_mutator.py
  gene_swap_mutator.py
  single_gene_mutator.py
  single_shift_mutator.py
  src/mlrose_ky/generators
  tsp_generator.py
  src/mlrose_ky/neural
  __init__.py
  nn_core.py
  src/mlrose_ky/neural/activation
  identity.py
  leaky_relu.py
  sigmoid.py
  src/mlrose_ky/opt_probs
  discrete_opt.py
  max_k_color_opt.py
  src/mlrose_ky/runners
  _nn_runner_base.py
  _runner_base.py
  tests
  test_decay.py
Project Total  

The report is truncated to 25 files out of 52. To see the full report, please visit the workflow summary page.

This report was generated by python-coverage-comment-action

knakamura13 commented 2 months ago

Fixed the problems with miss-named class instances and all tests are passing now. I'll merge this PR, but want to note that there are other classes that still need to be renamed in #7.

Thanks for the help on this!