Skip to content

[docs] minor cleanups in the lora docs. #11770

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

Merged
merged 5 commits into from
Jun 24, 2025
Merged

[docs] minor cleanups in the lora docs. #11770

merged 5 commits into from
Jun 24, 2025

Conversation

sayakpaul
Copy link
Member

What does this PR do?

  • Fix docstrings examples.
  • Add missing docstrings.
  • Organize the position of the methods and properties.
@sayakpaul sayakpaul requested a review from stevhliu June 23, 2025 02:34
@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.

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 for cleaning up 🧼

Args:
Deletes the LoRA layers of `adapter_name` for the unet and text-encoder(s).
adapter_names (`Union[List[str], str]`):
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
adapter_names (`Union[List[str], str]`):
adapter_names (`List[str]` or `str`):
Copy link
Member Author

Choose a reason for hiding this comment

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

I think this kind of corrections (expanding Union to be an "or" in the docstrings) should be made in a bulk PR. So, skipping it here.

@sayakpaul sayakpaul merged commit 9254271 into main Jun 24, 2025
32 of 33 checks passed
@sayakpaul sayakpaul deleted the lora-docs-refactor branch June 24, 2025 02:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
3 participants
close