-
Notifications
You must be signed in to change notification settings - Fork 5.4k
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
Missing docs in multiple diffusers/models files #5249
Comments
I think it was on purpose in some sense because these blocks are usually modified to accommodate different features. But maybe @patrickvonplaten can shed more light! |
Hey @a-r-r-o-w, Good point! Actually it would be amazing if all these blocks would have better type hints and doc strings - we simply forgot to add those when the library was created |
Got it @patrickvonplaten! Will work on this and open a PR as soon as possible 🚀 |
Hey @patrickvonplaten. After making changes to multiple files and viewing the diff, I find it really difficult to go over and review the changes I've made to make sure they are correct, and I think it would feel the same for other reviewers. Should I open PRs one by one for the different files and would you like me to maintain a tracker for the different files like you did #287? This would also allow for other collaborators to open PRs with improvements on files that are yet to have type hints and docs added. |
@a-r-r-o-w Go ahead and open smaller PRs for the type hints. And I can do a review. |
Multiple classes such as this in the models directory are missing documentation or an explanation for what the different parameters mean, and sometimes type hints. Has it been done this way by choice to allow for a clean and direct code view? if not, I would be happy to take this up as an issue and write the docs.
The text was updated successfully, but these errors were encountered: