Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

issue to track doc work #3

Closed
3 of 5 tasks
nkapila6 opened this issue Aug 15, 2024 · 3 comments
Closed
3 of 5 tasks

issue to track doc work #3

nkapila6 opened this issue Aug 15, 2024 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@nkapila6
Copy link
Collaborator

nkapila6 commented Aug 15, 2024

Adding this issue to track doc work.

  • a tutorial on how to use runners
  • fixing links in about section
  • update about section to new readme.md
  • adding source links to each class, etc
  • changing mlrose to mlrose-ky
@nkapila6 nkapila6 added the documentation Improvements or additions to documentation label Aug 15, 2024
@nkapila6
Copy link
Collaborator Author

Addressed some to-dos in #4

@nkapila6
Copy link
Collaborator Author

nkapila6 commented Aug 18, 2024

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
Copy link
Collaborator Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant