⚠ This page is served via a proxy. Original site: https://github.com
This service does not collect credentials or authentication data.
Skip to content

docs: update video docs#864

Merged
tastelikefeet merged 3 commits intomodelscope:mainfrom
suluyana:fix/video_gen_exclude_edit_file
Feb 7, 2026
Merged

docs: update video docs#864
tastelikefeet merged 3 commits intomodelscope:mainfrom
suluyana:fix/video_gen_exclude_edit_file

Conversation

@suluyana
Copy link
Collaborator

@suluyana suluyana commented Feb 7, 2026

Change Summary

Related issue number

Checklist

  • The pull request title is a good summary of the changes - it will be used in the changelog
  • Unit tests for the changes exist
  • Run pre-commit install and pre-commit run --all-files before git commit, and passed lint check.
  • Documentation reflects the changes where applicable

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @suluyana, 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 the documentation for the 'Singularity Cinema' video generation project, providing a more comprehensive and user-friendly guide. The changes aim to clarify the project's features, streamline the setup and execution processes, and offer detailed insights into its modular architecture and parameter tuning. The updated documentation includes practical examples and troubleshooting guidance, making it easier for users to get started and customize their video generation workflows.

Highlights

  • Enhanced Project Description: The core description of 'Singularity Cinema' has been expanded to clearly articulate its full capabilities, including script/storyboard generation, voice-over, subtitles, images, and optional text-to-video features.
  • New Video Showcases: A dedicated 'Showcase' section has been added, featuring video previews to visually demonstrate the project's output and capabilities.
  • Restructured Installation and Usage Guide: The installation process is now more detailed, explicitly listing environment requirements (Python, Node.js, FFmpeg). The 'Running' section has been completely revamped with clearer steps for API key preparation, configuration notes (including how command-line arguments override YAML), and comprehensive example commands.
  • Detailed Execution Pipeline: The 'Technical Principles' section has been replaced with an in-depth 'Execution Pipeline and Effect Tuning' guide. This new section breaks down the video generation workflow into 9 distinct steps, detailing inputs, outputs, code entry points, and providing guidance on how to debug or re-run specific parts of the pipeline.
  • Improved Parameter Tuning Guidance: The 'Tunable Parameters' section now advises against modifying the default YAML configuration directly, instead recommending the use of command-line arguments for overrides, with practical examples.

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

Changelog
  • docs/en/Projects/VideoGeneration.md
    • Updated the project description to include details about script/storyboard generation, voice-over, subtitles, images, and text-to-video capabilities.
    • Added a 'Showcase' section with video previews.
    • Restructured the 'Installation' section, explicitly listing environment requirements (Python, Node.js, FFmpeg) and separating code cloning and dependency installation.
    • Refined 'Compatibility' details, specifying supported video types, language flexibility, and external material handling.
    • Replaced specific LLM/AIGC model test ranges in 'Limitations' with a general statement about model quality and configuration recommendations.
    • Completely revamped the 'Running' section, introducing numbered steps for API key preparation (with detailed examples for LLM, text-to-image, multimodal LLM), material preparation, configuration notes (explaining command-line overrides with YAML structure examples), example commands, and output/failure retry mechanisms.
    • Replaced the 'Technical Principles' section with a new 'Execution Pipeline and Effect Tuning' section, which outlines 9 distinct steps of the video generation workflow, including inputs, outputs, code entry points, and scope for each, along with an example for redoing specific animation segments.
    • Updated the 'Adjustable Parameters' section to 'Tunable Parameters (Overview)', recommending command-line overrides instead of direct YAML modification and providing common parameter examples.
  • docs/zh/Projects/video-generation.md
    • Mirrored all the documentation updates from the English version, ensuring consistency across languages. This includes the updated project description, '效果展示' (Showcase), restructured '安装' (Installation), refined '适配性和局限性' (Compatibility and Limitations), the comprehensive new '运行' (Run) section, the detailed '运行流程与效果调试' (Execution Pipeline and Effect Tuning), and the '可调参数(概览)' (Tunable Parameters (Overview)).
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@tastelikefeet tastelikefeet merged commit 45a0a3f into modelscope:main Feb 7, 2026
1 of 2 checks passed
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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 provides a significant update to the documentation for the Singularity Cinema project, for both English and Chinese versions. The new documentation is much more structured, detailed, and user-friendly. My review focuses on improving consistency and clarity. I've pointed out a few minor issues: an inconsistent query language in an example command in the English document, a missing project description in the Chinese document, and a minor formatting inconsistency. Overall, this is a great improvement to the project's documentation.

Comment on lines +153 to +158
# For the English version, replace the query content with:
# "Convert /home/user/workspace/ms-agent/projects/singularity_cinema/test_files/J.部署.md
# into a short video in a blue-themed style, making sure to use the important images from the document.
# The short video must be in English."
ms-agent run --project singularity_cinema \
--query "把/{path_to_ms-agent}/projects/singularity_cinema/test_files/J.部署.md转为短视频,蓝色风格,注意使用其中重要的图片" \
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

For better clarity in the English documentation, the example command should use an English query directly, rather than a Chinese one with an explanatory comment. A concise, helpful comment explaining the command's purpose would be more effective.

Suggested change
# For the English version, replace the query content with:
# "Convert /home/user/workspace/ms-agent/projects/singularity_cinema/test_files/J.部署.md
# into a short video in a blue-themed style, making sure to use the important images from the document.
# The short video must be in English."
ms-agent run --project singularity_cinema \
--query "把/{path_to_ms-agent}/projects/singularity_cinema/test_files/J.部署.md转为短视频,蓝色风格,注意使用其中重要的图片" \
# This example converts a local markdown file into an English short video with a blue theme.
ms-agent run --project singularity_cinema \
--query "Convert /{path_to_ms-agent}/projects/singularity_cinema/test_files/J.部署.md into a short video in a blue-themed style, making sure to use the important images from the document. The short video must be in English." \

---

# 奇点放映室 (Singularity Cinema)

Copy link
Contributor

Choose a reason for hiding this comment

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

medium

The detailed project description, which was added to the English documentation, is missing here. For consistency, please add a similar description in Chinese.

Suggested change
# 奇点放映室 (Singularity Cinema)
一个轻量级的短视频生成器:它使用大型语言模型生成**脚本和故事板**,然后自动制作**画外音/(可选)字幕/图像/(可选)文生视频**,并最终将它们合成为一个短视频。

cd projects/singularity_cinema
pip install -r requirements.txt
```

Copy link
Contributor

Choose a reason for hiding this comment

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

medium

There is an extra blank line here, which is not present in the English version of the documentation. Please remove it for formatting consistency.

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.

2 participants