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

Update transformer2d.md title #8375

Merged
merged 3 commits into from
Jun 4, 2024
Merged

Update transformer2d.md title #8375

merged 3 commits into from
Jun 4, 2024

Conversation

salcc
Copy link
Contributor

@salcc salcc commented May 31, 2024

For the other classes (e.g., UNet2DModel) the title of the documentation coincides with the name of the class, but that was not the case for Transformer2DModel.

For the other classes (e.g., UNet2DModel) the title of the documentation coincides with the name of the class, but that was not the case for Transformer2DModel.
@sayakpaul sayakpaul requested a review from stevhliu June 1, 2024 07:10
Copy link
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Can you also update it in the toctree as well? Let's also update TransformerTemporal and PriorTransformer to follow this convention.

@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.

@salcc
Copy link
Contributor Author

salcc commented Jun 3, 2024

I updated TransformerTemporalModel and also a few more models that also had "Model" in the class name but not in the docs title.

PriorTransformer class name does not contain Model so I just removed the space but did not add the Model because that would require to change the code as well, which could break some code I guess.

Copy link
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice, thank you for also updating some of the other models like PixArt and DiT!

@stevhliu stevhliu merged commit dc89434 into huggingface:main Jun 4, 2024
1 check passed
@salcc salcc deleted the patch-1 branch June 4, 2024 00:07
sayakpaul pushed a commit that referenced this pull request Dec 23, 2024
* Update transformer2d.md title

For the other classes (e.g., UNet2DModel) the title of the documentation coincides with the name of the class, but that was not the case for Transformer2DModel.

* Update model docs titles for consistency with class names
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants