[Utils] add utilities for checking if certain utilities are properly documented

[sayakpaul]

What does this PR do?

We have a bunch of attention processors, normalization layers, and activation layers in the codebase and they have thin documentation. This is fine because users can always see their usage in the context of a model or a pipeline to get the fuller picture.

But since we document them in separate pages too, (such as this, this, and this), I think it makes sense to ensure these docs properly reflect what all we support.

This PR adds utilities to do that. @stevhliu I think you will like it :-)

[sayakpaul]

@stevhliu any idea why the doc build fails?

[stevhliu]

I'm not sure, the formatting all looks correct to me but for reason autodoc.py can't find them! cc @mishig25 have you encountered this before?

[sayakpaul]

@mishig25 a gentle ping.

[mishig25]

let me check

[mishig25]

LayerNorm is the reason why doc-builder is not building.

I've inspected a bit.
All other norms are diffuser defined classes:

>>> import diffusers
>>> diffusers.models.normalization.GlobalResponseNorm
<class 'diffusers.models.normalization.GlobalResponseNorm'>

whereas LayerNorm seems to be alias to pytorch defined class (and doc-builder autodoc does not work with pytorch defined classes):

>>> import diffusers
>>> diffusers.models.normalization.LayerNorm
<class 'torch.nn.modules.normalization.LayerNorm'>

diffusers/src/diffusers/models/normalization.py

Line 198 in 900cd1c

LayerNorm = nn.LayerNorm

Therefore, as a simple fix: I'd suggest replacing [[autodoc]] models.normalization.LayerNorm with something like: You can also use LayerNorm and add markdown link to pytorch layernorm doc

[sayakpaul]

Thanks @mishig25. I think it'd be okay to remove LayerNorm from our doc because our implementation is really a special case and is already supported in the latest versions of PyTorch.

[HuggingFaceDocBuilderDev]

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

[sayakpaul]

@stevhliu @yiyixuxu this is ready for review.

[stevhliu]

LGTM, thanks!

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity. If you think this still needs to be addressed please comment on this thread.

Please note that issues that do not follow the contributing guidelines are likely to be ignored.

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity. If you think this still needs to be addressed please comment on this thread.

Please note that issues that do not follow the contributing guidelines are likely to be ignored.

[yiyixuxu]

can you take a look here @DN6?

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity. If you think this still needs to be addressed please comment on this thread.

Please note that issues that do not follow the contributing guidelines are likely to be ignored.

[yiyixuxu]

super cooll! thanks!

[hlky]

Nice!