-
Notifications
You must be signed in to change notification settings - Fork 6.3k
[Docs] Models #416
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
[Docs] Models #416
Conversation
The documentation is not available anymore as the PR was closed or merged. |
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.
Very cool! Could we also add one more sentence to all public model classes as stated here:
https://github.com/huggingface/diffusers/pull/416/files#r965807798
Also could you also add a doctsring to the forward method? :-)
Co-authored-by: Patrick von Platen <patrick.v.platen@gmail.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.
Looking good! I just pointed out some mismatches between the docstrings and the formal arguments lists.
heads (:obj:`int`, *optional*, defaults to 8): The number of heads to use for multi-head attention. | ||
dim_head (:obj:`int`, *optional*, defaults to 64): The number of channels in each head. |
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.
We should consolidate these names across modules in the future. The are called n_heads
and d_head
in BasicTransformerBlock
.
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.
Leaving for future PR for now due to time constraint
up_block_types (`Tuple[str]`, *optional*, defaults to : | ||
obj:`("UpDecoderBlock2D",)`): Tuple of upsample block types. | ||
block_out_channels (`Tuple[int]`, *optional*, defaults to : | ||
obj:`(64,)`): Tuple of block output channels. |
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.
Missing: layers_per_block
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.
Leaving for future PR for now due to time constraint
up_block_types (`Tuple[str]`, *optional*, defaults to : | ||
obj:`("UpDecoderBlock2D",)`): Tuple of upsample block types. | ||
block_out_channels (`Tuple[int]`, *optional*, defaults to : | ||
obj:`(64,)`): Tuple of block output channels. |
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.
Missing: layers_per_block
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.
Leaving for future PR for now due to time constraint
Co-authored-by: Pedro Cuenca <pedro@huggingface.co>
* docs for attention * types for embeddings * unet2d docstrings * UNet2DConditionModel docstrings * fix typos * style and vq-vae docstrings * docstrings for VAE * Update src/diffusers/models/unet_2d.py Co-authored-by: Patrick von Platen <patrick.v.platen@gmail.com> * make style * added inherits from sentence * docstring to forward * make style * Apply suggestions from code review Co-authored-by: Pedro Cuenca <pedro@huggingface.co> * finish model docs * up Co-authored-by: Patrick von Platen <patrick.v.platen@gmail.com> Co-authored-by: Pedro Cuenca <pedro@huggingface.co>
for issue #293