Skip to content

Conversation

@DN6
Copy link
Collaborator

@DN6 DN6 commented Feb 1, 2024

What does this PR do?

Noticed a few small issues scattered throughout the video docs like missing example snippets, incorrect alt text etc.

This PR:

  1. Fixes these issues
  2. Updates the docstrings for the pipeline outputs for each of the video pipelines that use the new tensor_to_vid export to explicity communicate that the frames are indexed based on the batch size.

Fixes # (issue)

Before submitting

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

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

@DN6 DN6 requested review from sayakpaul and yiyixuxu February 1, 2024 09:06

</Tip>

## Usage example
Copy link
Member

Choose a reason for hiding this comment

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

The usage example is already generated as a part of the pipeline call code snippet. So, this is redundant here. Until and unless there are some extended bits we wanna discuss the API spec doc should clean and lean. For detailed deep dives, having separate guides are preferable.


prompt = "Spiderman is surfing"
video_frames = pipe(prompt).frames
video_frames = pipe(prompt).frames[0]
Copy link
Member

Choose a reason for hiding this comment

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

Have we clarified about this part well enough?

Copy link
Member

@sayakpaul sayakpaul left a comment

Choose a reason for hiding this comment

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

Looking good. I think we should maybe add a separate entry in the docs somewhere for tensor2vid.

@DN6 DN6 merged commit f09ca90 into main Feb 5, 2024
AmericanPresidentJimmyCarter pushed a commit to AmericanPresidentJimmyCarter/diffusers that referenced this pull request Apr 26, 2024
* update

* update

* update

* Update src/diffusers/pipelines/i2vgen_xl/pipeline_i2vgen_xl.py

Co-authored-by: YiYi Xu <[email protected]>

* update

* update

---------

Co-authored-by: YiYi Xu <[email protected]>
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.

5 participants