Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update falcon mamba card #37253

Merged
merged 7 commits into from
Apr 7, 2025
Merged

Update falcon mamba card #37253

merged 7 commits into from
Apr 7, 2025

Conversation

ricalanis
Copy link
Contributor

@ricalanis ricalanis commented Apr 3, 2025 •
edited by stevhliu
Loading

#36979

  • Updated the FalconMamba model card
  • Second contrib, thank you again for your patience <3

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a Github issue or the forum? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines, and
    here are tips on formatting docstrings.
  • [] Did you write any new necessary tests? NA

@github-actions github-actions bot marked this pull request as draft April 3, 2025 15:46
@github-actions GitHub Actions
Copy link

github-actions bot commented Apr 3, 2025

Hi 👋, thank you for opening this pull request! The pull request is converted to draft by default. The CI will be paused while the PR is in draft mode. When it is ready for review, please click the Ready for review button (at the bottom of the PR page). This will assign reviewers and trigger CI.

@ricalanis ricalanis changed the title feat: edit falcon mamba card Update falcon mamba card Apr 3, 2025
@ricalanis ricalanis marked this pull request as ready for review April 3, 2025 15:46
@github-actions github-actions bot requested a review from stevhliu April 3, 2025 15:46
@stevhliu stevhliu mentioned this pull request Apr 3, 2025
Open
stevhliu
stevhliu approved these changes Apr 3, 2025
View reviewed changes
Copy link
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

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

Super nice job! 🤩

docs/source/en/model_doc/falcon_mamba.md Outdated
@@ -14,97 +14,105 @@ rendered properly in your Markdown viewer.

-->

# FalconMamba

<div class="flex flex-wrap space-x-1">
Copy link
Member

Choose a reason for hiding this comment

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

Wrap this with the below to align it to the right:

<div style="float: right;">
   badges
</div>

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh! Forgot about that. Adding.

@ricalanis
Copy link
Contributor Author

Fixed comments, ready for review.

@HuggingFaceDocBuilderDev
Copy link

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

stevhliu
stevhliu approved these changes Apr 4, 2025
View reviewed changes
Copy link
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

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

Thanks, one last comment!

docs/source/en/model_doc/falcon_mamba.md Outdated
Comment on lines 113 to 116
## Notes

- FalconMamba is based on the Mamba architecture. The same [tips and best practices](./mamba) for Mamba models are relevant here.
- The architecture is compatible with `torch.compile` for faster generation via `model = torch.compile(model)`.
Copy link
Member

Choose a reason for hiding this comment

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

I think we can remove these notes as they're not that useful. The model is automatically compiled when we set cache_implementation="static" in generate

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed!

@stevhliu stevhliu merged commit 5e85509 into huggingface:main Apr 7, 2025
10 checks passed
vasqu pushed a commit to vasqu/transformers that referenced this pull request Apr 7, 2025
@ricalanis @stevhliu @vasqu
Update falcon mamba card (huggingface#37253)
1e1e588 
* feat: edit falcon mamba card

* fix: edit statement on falconmamba arch

* Update docs/source/en/model_doc/falcon_mamba.md

Co-authored-by: Steven Liu <[email protected]>

* Update docs/source/en/model_doc/falcon_mamba.md

Co-authored-by: Steven Liu <[email protected]>

* Update docs/source/en/model_doc/falcon_mamba.md

Co-authored-by: Steven Liu <[email protected]>

* fix: add right indent for tags

* fix: remove notas

---------

Co-authored-by: Steven Liu <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stevhliu stevhliu stevhliu approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ricalanis @HuggingFaceDocBuilderDev @stevhliu