Skip to content

docs: document processor_output usage in VLM offline engine notebook#12831

Merged
zhaochenyang20 merged 3 commits intosgl-project:refactor-engine-vlm-paramsfrom
minleminzui:refactor-engine-vlm-params
Nov 7, 2025
Merged

docs: document processor_output usage in VLM offline engine notebook#12831
zhaochenyang20 merged 3 commits intosgl-project:refactor-engine-vlm-paramsfrom
minleminzui:refactor-engine-vlm-params

Conversation

@minleminzui
Copy link
Copy Markdown
Collaborator

@minleminzui minleminzui commented Nov 7, 2025

Motivation

Update vlm_query.ipynb to include a Qwen2.5-VL example that passes
HuggingFace processor_output into Engine.generate, aligning the docs
with the three supported VLM input formats (basic, processor_output,
precomputed_embedding).

#10532

Modifications

Accuracy Tests

Benchmarking and Profiling

Checklist

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @minleminzui, 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 enhances the vlm_query.ipynb notebook by integrating a new example that showcases how to effectively use HuggingFace's processor_output as an input format for the VLM offline engine. This addition provides comprehensive guidance for users on all supported input methods, improving the clarity and completeness of the documentation.

Highlights

  • Documentation Update: The pull request updates the vlm_query.ipynb notebook to include a new example demonstrating the usage of processor_output with the VLM offline engine.
  • Qwen2.5-VL Example: A specific example using the Qwen2.5-VL model is added to illustrate how to pass HuggingFace processor_output into Engine.generate.
  • Input Format Alignment: This change ensures the documentation aligns with all three supported VLM input formats: basic, processor_output, and precomputed_embedding.
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.

Copy link
Copy Markdown
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 updates the VLM offline engine notebook to include an example of using processor_output. The added example is a great addition for documenting all supported input formats. I've suggested a small simplification to the new code example to make it clearer and more concise by removing a redundant parameter. The rest of the changes are minor cleanups which look good.

Comment thread docs/advanced_features/vlm_query.ipynb
@zhaochenyang20 zhaochenyang20 merged commit 1dba74d into sgl-project:refactor-engine-vlm-params Nov 7, 2025
1 check passed
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