-
Notifications
You must be signed in to change notification settings - Fork 6.6k
Multiple small fixes to Video Pipeline docs #6805
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
Conversation
|
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. |
|
|
||
| </Tip> | ||
|
|
||
| ## Usage example |
There was a problem hiding this comment.
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] |
There was a problem hiding this comment.
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?
sayakpaul
left a comment
There was a problem hiding this 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.
Co-authored-by: YiYi Xu <[email protected]>
* 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]>
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:
tensor_to_videxport to explicity communicate that the frames are indexed based on the batch size.Fixes # (issue)
Before submitting
documentation guidelines, and
here are tips on formatting docstrings.
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.