-
Notifications
You must be signed in to change notification settings - Fork 236
[docs] Update docs and README #975
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
Summary of ChangesHello @SolitaryThinker, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly updates and expands the project's documentation. It introduces a clear overview of supported models and their applications directly in the main README, alongside a new, in-depth guide to various training and distillation recipes. These changes aim to improve user onboarding and provide clearer pathways for utilizing FastVideo's capabilities, with corresponding updates to the documentation navigation structure. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
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.
Code Review
This pull request updates the documentation by adding a model coverage section to the main README and introducing a new training_recipes.md page. The changes improve the project's documentation and user guidance. I've found a few minor issues: a small HTML formatting error in the README and some inconsistencies in script names and commands within the new training recipes guide. Addressing these will enhance clarity and prevent potential user confusion. Please see my detailed comments for suggestions.
README.md
Outdated
| | [SFWan2.2 T2V A14B](docs/distillation/examples/SFWan2.2-A14B.md) | Causal distillation (self-forcing/SFwan) | Text-to-Video distillation | | ||
|
|
||
| <p align="center"> | ||
| | 🕹️ <a href="https://fastwan.fastvideo.org/"<b>Online Demo</b></a> | <a href="https://hao-ai-lab.github.io/FastVideo"><b>Documentation</b></a> | <a href="https://hao-ai-lab.github.io/FastVideo/inference/inference_quick_start/"><b> Quick Start</b></a> | 🤗 <a href="https://huggingface.co/collections/FastVideo/fastwan-6886a305d9799c8cd1496408" target="_blank"><b>FastWan</b></a> | 🟣💬 <a href="https://join.slack.com/t/fastvideo/shared_invite/zt-3f4lao1uq-u~Ipx6Lt4J27AlD2y~IdLQ" target="_blank"> <b>Slack</b> </a> | 🟣💬 <a href="https://ibb.co/c7g1qdD" target="_blank"> <b> WeChat </b> </a> | |
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.
There's a minor HTML syntax error in the "Online Demo" link. The <b> tag is incorrectly placed, which may cause rendering issues in some markdown parsers. It should be placed inside the <a> tag to ensure the text is both a link and bolded.
| | 🕹️ <a href="https://fastwan.fastvideo.org/"<b>Online Demo</b></a> | <a href="https://hao-ai-lab.github.io/FastVideo"><b>Documentation</b></a> | <a href="https://hao-ai-lab.github.io/FastVideo/inference/inference_quick_start/"><b> Quick Start</b></a> | 🤗 <a href="https://huggingface.co/collections/FastVideo/fastwan-6886a305d9799c8cd1496408" target="_blank"><b>FastWan</b></a> | 🟣💬 <a href="https://join.slack.com/t/fastvideo/shared_invite/zt-3f4lao1uq-u~Ipx6Lt4J27AlD2y~IdLQ" target="_blank"> <b>Slack</b> </a> | 🟣💬 <a href="https://ibb.co/c7g1qdD" target="_blank"> <b> WeChat </b> </a> | | |
| | 🕹️ <a href="https://fastwan.fastvideo.org/"><b>Online Demo</b></a> | <a href="https://hao-ai-lab.github.io/FastVideo"><b>Documentation</b></a> | <a href="https://hao-ai-lab.github.io/FastVideo/inference/inference_quick_start/"><b> Quick Start</b></a> | 🤗 <a href="https://huggingface.co/collections/FastVideo/fastwan-6886a305d9799c8cd1496408" target="_blank"><b>FastWan</b></a> | 🟣💬 <a href="https://join.slack.com/t/fastvideo/shared_invite/zt-3f4lao1uq-u~Ipx6Lt4J27AlD2y~IdLQ" target="_blank"> <b>Slack</b> </a> | 🟣💬 <a href="https://ibb.co/c7g1qdD" target="_blank"> <b> WeChat </b> </a> | |
docs/training/training_recipes.md
Outdated
| - DMD-only: `sbatch examples/distill/Wan2.1-T2V/Wan-Syn-Data-480P/distill_dmd_t2v.slurm` | ||
| - DMD+VSA: `sbatch examples/distill/Wan2.1-T2V/Wan-Syn-Data-480P/distill_dmd_VSA_t2v.slurm` |
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 script names for bidirectional distillation appear to be inconsistent with the main distillation documentation in docs/distillation/dmd.md. For the Wan2.1 1.3B model, dmd.md refers to distill_dmd_VSA_t2v_1.3B.slurm and does not seem to mention a separate DMD-only slurm script. This discrepancy could be confusing for users. Please verify and align the script names with the available recipes to ensure the documentation is accurate.
docs/training/training_recipes.md
Outdated
| 1. Download or prepare your dataset as described in each example page (e.g., `bash examples/distill/SFWan2.1-T2V/download_dataset.sh`). | ||
| 2. Run the provided launchers for your target model: | ||
| - SFWan2.1 T2V: `sbatch examples/distill/SFWan2.1-T2V/distill_dmd_t2v_1.3B.sh` | ||
| - SFWan2.2 A14B: `bash examples/distill/SFWan2.2-A14B/distill_dmd.sh` |
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 command to run the distillation script for SFWan2.2 A14B should probably use sbatch instead of bash. The script distill_dmd.sh contains #SBATCH directives for SLURM, and the corresponding README.md in examples/distill/SFWan2.2-A14B/ also uses sbatch. Using bash would execute the script directly on the login node, ignoring the cluster resource allocation settings.
| - SFWan2.2 A14B: `bash examples/distill/SFWan2.2-A14B/distill_dmd.sh` | |
| - SFWan2.2 A14B: `sbatch examples/distill/SFWan2.2-A14B/distill_dmd.sh` |
a91ded7 to
3a63725
Compare
No description provided.