-
Notifications
You must be signed in to change notification settings - Fork 432
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
Configured pydocstyle
for the trainer, callbacks, loggers, optimizers, and utils.
#1089
Conversation
…rs, and utils. This PR enables the `pydocstyle` pre-commit hook for most of the codebase. Docstrings were brought up to compliance so they would pass the pydocstyle check. Model, dataset, and algorithm docstrings will be addressed in future PRs.
These are no longer necessarry, as the trainer is automatically cleaned up on `__del__`.
This PR is obv very large and mostly contains routine docstring edits. I won't look at each one; I will trust that pydoctest does what it claims to do. Any diffs that do other things that we should take special look at in this PR? Like the pre-commit config or anything else? |
I know it's a bunch of files, but it would be super helpful if you could double check that there aren't any unintentional changes from a sloppy merge that I might have done (e.g. remove new functionality). Let me update it against the latest dev. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
there are a few changes in here that are unrelated to docs. I've flagged them so you can confirm you intend them to be in here.
Also fixed a few typos and made some grammar suggestions. Most are a matter of opinion, you don't have to accept them.
Other than that LGTM, thanks for taking the time to clean this stuff up!
Co-authored-by: Austin <A-Jacobson@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm, small nits
This PR enables the
pydocstyle
pre-commit hook for most of the codebase. Docstrings were brought up to compliance so they would pass the pydocstyle check.trainer.engine.close
, as nowclose()
is invoked automatically in__del__
as part of Multiple calls toTrainer.fit()
#948Model, dataset, and algorithm docstrings will be addressed in future PRs.