Skip to content

Conversation

tdoublep
Copy link
Member

@tdoublep tdoublep commented Aug 28, 2025

Purpose

Update documentation to reflect latest state of mamba support, and add some instructions to help people contribute new mamba-based models in the future.

cc @heheda12345

Test Plan

n/a

Test Result

n/a

Essential Elements of an Effective PR Description Checklist
  • The purpose of the PR, such as "Fix some issue (link existing issues this PR will resolve)".
  • The test plan, such as providing test command.
  • The test results, such as pasting the results comparison before and after, or e2e results
  • (Optional) The necessary documentation update, such as updating supported_models.md and examples for a new model.
  • (Optional) Release notes update. If your change is user facing, please update the release notes draft in the Google Doc.

Signed-off-by: Thomas Parnell <[email protected]>
Signed-off-by: Thomas Parnell <[email protected]>
Signed-off-by: Thomas Parnell <[email protected]>
@tdoublep tdoublep requested a review from hmellor as a code owner August 28, 2025 10:59
@mergify mergify bot added the documentation Improvements or additions to documentation label Aug 28, 2025
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 updates the documentation to reflect the current state of Mamba model support. It adds a comprehensive guide for contributors on how to add new Mamba-based models, covering different scenarios and providing helpful code references. The v1 usage guide is also updated to reflect the latest supported models and to clarify the status of prefix caching. The documentation changes are clear, accurate, and will be very helpful for the community. The updates are consistent with the provided code context. Overall, this is a great contribution to improving the project's documentation.

Signed-off-by: Thomas Parnell <[email protected]>
@tdoublep tdoublep changed the title Mamba contributing docs [Docs] [V1] [Hybrid] Add new documentation re: contributing mamba-based models Aug 28, 2025
@tdoublep
Copy link
Member Author

Does anyone know if using gh-file with line numbers will render as-intended?

Copy link
Collaborator

@heheda12345 heheda12345 left a comment

Choose a reason for hiding this comment

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

Nice job!!!! Can you also mention that MambaCacheManager is only for v0 and don't need to add related code and other if v0 code path for new models?

Signed-off-by: Thomas Parnell <[email protected]>
@tdoublep
Copy link
Member Author

Can you also mention that MambaCacheManager is only for v0 and don't need to add related code and other if v0 code path for new models?

Done

Signed-off-by: Thomas Parnell <[email protected]>
Copy link
Collaborator

@heheda12345 heheda12345 left a comment

Choose a reason for hiding this comment

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

LGTM! Very helpful doc.

@heheda12345 heheda12345 enabled auto-merge (squash) August 29, 2025 16:41
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Aug 29, 2025
@heheda12345 heheda12345 merged commit 1c26b42 into vllm-project:main Aug 29, 2025
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation ready ONLY add when PR is ready to merge/full CI is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants