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

Missing docs in multiple diffusers/models files #5249

Closed
a-r-r-o-w opened this issue Sep 30, 2023 · 5 comments · Fixed by #5293, #5299 or #5312
Closed

Missing docs in multiple diffusers/models files #5249

a-r-r-o-w opened this issue Sep 30, 2023 · 5 comments · Fixed by #5293, #5299 or #5312

Comments

@a-r-r-o-w
Copy link
Member

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.

@sayakpaul
Copy link
Member

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!

@patrickvonplaten
Copy link
Contributor

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

@a-r-r-o-w
Copy link
Member Author

Got it @patrickvonplaten! Will work on this and open a PR as soon as possible 🚀

@a-r-r-o-w
Copy link
Member Author

a-r-r-o-w commented Oct 5, 2023

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.

@DN6
Copy link
Collaborator

DN6 commented Oct 6, 2023

@a-r-r-o-w Go ahead and open smaller PRs for the type hints. And I can do a review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants