Feat/video readme

[suluyana]

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

[dosubot]

Related Documentation

No published documentation to review for changes on this repository.

Write your first living document

^{How did I do? Any feedback?}  

[gemini-code-assist]

Summary of Changes

Hello @suluyana, I'm Gemini Code Assist¹! 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 enhances the ms-agent framework by introducing a more streamlined way to run pre-defined projects via a new CLI argument. It also provides a substantial update to the singularity_cinema project's documentation, making it more user-friendly and informative, and includes a new resource detailing LLM inference and deployment strategies. These changes collectively aim to improve the developer experience and provide clearer guidance for utilizing the agent's capabilities.

Highlights

• CLI Project Selection: A new --project argument has been added to the ms-agent run command, enabling users to easily select and execute built-in projects directly from the command line.
• Improved Project Packaging: The projects directory is now correctly included in the distributed package, ensuring that all project-related files are available upon installation through modifications in MANIFEST.in and setup.py.
• Enhanced singularity_cinema Documentation: The README.md for the singularity_cinema project has been extensively updated with a video showcase, detailed API key setup instructions, comprehensive command-line configuration examples, and a revised technical workflow, replacing manim with remotion.
• New LLM Deployment Guide: A new markdown file (J.部署.md) has been added, providing in-depth information on LLM inference methods, hyperparameters, KVCache, and various deployment frameworks like VLLM, SWIFT, llama.cpp, and FastChat.
• Dependency Management: The manim dependency was removed from singularity_cinema's requirements, and several new packages (e.g., requests, pyyaml, pandas) were added to the main framework requirements to support new functionalities.

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

[gemini-code-assist]

Code Review

This pull request introduces a new feature to run built-in projects, like singularity_cinema, directly via a --project command-line argument. This is achieved by packaging the projects directory and using importlib.resources to access them. The singularity_cinema project itself has been updated, notably with a much-improved README.md and a switch from manim to remotion. The changes are well-structured. I've found a few areas for improvement regarding code duplication, error handling, and documentation accuracy.

[gemini-code-assist]

Catching a broad Exception can hide bugs and make debugging harder. It's better to catch more specific exceptions that you anticipate from the importlib_resources operations. For example, ModuleNotFoundError might be more appropriate if the package isn't found. While the goal of not crashing the help text is valid, being more specific with exception handling improves code robustness.

[gemini-code-assist]

This block of code duplicates the logic from list_builtin_projects. To improve maintainability and reduce redundancy, you should reuse the existing function.

Suggested change

	projects_root = importlib_resources.files('ms_agent').joinpath(
	'projects')
	available = []
	if projects_root.exists():
	available = [
	p.name for p in projects_root.iterdir() if p.is_dir()
	]
	raise ValueError(
	f'Unknown project: {project}. Available: {available}')
	available = list_builtin_projects()
	raise ValueError(
	f'Unknown project: {project}. Available: {available}')

[gemini-code-assist]

The list of steps in the '技术原理流程' (Technical principle flow) section is missing step 9 ('生成字幕' - Generate subtitles). The list jumps from step 8 to 10. According to workflow.yaml and the previous version of this file, this step should be included for the documentation to be accurate.

[gemini-code-assist]

The dotenv package is listed as a dependency twice in this file (the first one is on line 1). Please remove this duplicate entry.