search

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

issue to track doc work #3

Closed nkapila6 closed 1 month ago

nkapila6 commented 3 months ago

Adding this issue to track doc work.

nkapila6 commented 3 months ago

Addressed some to-dos in #4

nkapila6 commented 3 months ago

summary of work from #1

Here's my list of tasks for this project. Task 1 is completed; tasks 2—4 are in progress.

  • Fix all Python warnings and errors (except for some unavoidable warnings such as "duplicate code") ✅
  • Add Python 3.10 type hints to all function and method definitions, plus all method properties (e.g., self.foo: str = 'bar')
  • Add NumPy Doc docstrings to all functions and methods, plus at least a one-line docstring at the top of every file summarizing the file's contents
  • Add tests using Pytest, aiming for 100% code coverage
  • Search for TODO, FIXME, or other comments and resolve their respective issues
  • Optimize vanilla Python loops that can be vectorized with NumPy
  • Improve any other sub-optimal code, bugs, code quality issues, etc
  • Remove any commented-out code
nkapila6 commented 1 month ago

Moving to https://github.com/nkapila6/mlrose-ky