[docs] Model API #3562

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.

Sign up for GitHub

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

Jump to bottom

Merged

stevhliu merged 15 commits into huggingface:main from stevhliu:api-maintenance

Jun 30, 2023

Member

stevhliu commented May 25, 2023 •

edited

Loading

Creates a separate section for the models so that each model can have its own page and makes improvements to existing docstrings.

To do:

HuggingFaceDocBuilderDev commented May 25, 2023 •

edited

Loading

The documentation is not available anymore as the PR was closed or merged.

stevhliu force-pushed the api-maintenance branch 2 times, most recently from c543f90 to ddf5469 Compare

May 30, 2023 22:55

stevhliu commented

View reviewed changes

src/diffusers/models/controlnet.py Show resolved Hide resolved

Member Author

stevhliu commented May 31, 2023

First draft of the model APIs is done (I'll do a second pass for typos and such before merging)! Some questions I had while working on this:

The source of the replace function in FlaxControlNetOutput leads to a 404
Some parameters refer to classes that aren't currently documented; for example, the ImagePositionalEmbeddings in the sample_size parameter isn't documented. Should we expose the Embeddings classes here?
Some models like ResNet, DualTransformer2D, and T5Film aren't included either. Is this on purpose or should they also be documented?

stevhliu requested review from patrickvonplaten, sayakpaul, yiyixuxu and pcuenca

May 31, 2023 17:19

sayakpaul reviewed

View reviewed changes

docs/source/en/_toctree.yml Show resolved Hide resolved

sayakpaul reviewed

View reviewed changes

docs/source/en/_toctree.yml Outdated Show resolved Hide resolved

sayakpaul reviewed

View reviewed changes

docs/source/en/api/models/autoencoderkl.mdx Outdated Show resolved Hide resolved

sayakpaul reviewed

View reviewed changes

docs/source/en/api/models/autoencoderkl.mdx Outdated Show resolved Hide resolved

sayakpaul reviewed

View reviewed changes

docs/source/en/api/models/autoencoderkl.mdx Show resolved Hide resolved

sayakpaul reviewed

View reviewed changes

docs/source/en/api/models/overview.mdx Outdated Show resolved Hide resolved

sayakpaul reviewed

View reviewed changes

docs/source/en/api/models/transformer2d.mdx Outdated Show resolved Hide resolved

sayakpaul reviewed

View reviewed changes

docs/source/en/api/models/transformer2d.mdx Outdated Show resolved Hide resolved

sayakpaul reviewed

View reviewed changes

docs/source/en/api/models/transformer2d.mdx Outdated Show resolved Hide resolved

sayakpaul reviewed

View reviewed changes

docs/source/en/api/models/unet.mdx Outdated Show resolved Hide resolved

sayakpaul reviewed

View reviewed changes

docs/source/en/api/models/unet.mdx Outdated Show resolved Hide resolved

sayakpaul reviewed

View reviewed changes

docs/source/en/api/models/vq.mdx Outdated Show resolved Hide resolved

sayakpaul reviewed

View reviewed changes

src/diffusers/models/autoencoder_kl.py Outdated Show resolved Hide resolved

sayakpaul reviewed

View reviewed changes

Member

sayakpaul left a comment

Looking great!

Did a pass around the mdx files.

stevhliu marked this pull request as ready for review

June 12, 2023 17:38

patrickvonplaten reviewed

View reviewed changes

docs/source/en/api/models/transformer2d.mdx Outdated Show resolved Hide resolved

patrickvonplaten reviewed

View reviewed changes

src/diffusers/models/controlnet.py Show resolved Hide resolved

patrickvonplaten reviewed

View reviewed changes

src/diffusers/models/controlnet.py Show resolved Hide resolved

patrickvonplaten approved these changes

View reviewed changes

Contributor

patrickvonplaten left a comment

Super nice! Great effort on cleaning all these docs!

stevhliu added 2 commits

June 20, 2023 08:53


          add modelmixin and unets

e84f5c0


          remove old model page

2e27c84

stevhliu added 9 commits

June 20, 2023 08:53


          minor fixes

08a6cfb


          fix unet2dcondition

978ba6e


          add vqmodel and autoencoderkl

75f2aa2


          add rest of models

ba3c256


          fix autoencoderkl path

ff46bfd


          fix toctree

90f2ade


          fix toctree again

4f2c672


          apply feedback

0cc3e17


          apply feedback

6d67672

stevhliu force-pushed the api-maintenance branch from 53bcb3b to 6d67672 Compare

June 20, 2023 15:54

stevhliu and others added 4 commits

June 20, 2023 09:08


          fix copies

5bed504


          fix controlnet copy

47e9daa


          fix copies

69fac87


          Merge branch 'main' into api-maintenance

f9d632a

stevhliu merged commit 174dcd6 into huggingface:main

stevhliu deleted the api-maintenance branch

June 30, 2023 00:24

yoonseokjin pushed a commit to yoonseokjin/diffusers that referenced this pull request


          [docs] Model API (huggingface#3562)

9c48419

* add modelmixin and unets

* remove old model page

* minor fixes

* fix unet2dcondition

* add vqmodel and autoencoderkl

* add rest of models

* fix autoencoderkl path

* fix toctree

* fix toctree again

* apply feedback

* apply feedback

* fix copies

* fix controlnet copy

* fix copies

AmericanPresidentJimmyCarter pushed a commit to AmericanPresidentJimmyCarter/diffusers that referenced this pull request


          [docs] Model API (huggingface#3562)

ab670ff

* add modelmixin and unets

* remove old model page

* minor fixes

* fix unet2dcondition

* add vqmodel and autoencoderkl

* add rest of models

* fix autoencoderkl path

* fix toctree

* fix toctree again

* apply feedback

* apply feedback

* fix copies

* fix controlnet copy

* fix copies

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet