Skip to content

Update falcon mamba card#37253

Merged
stevhliu merged 7 commits intohuggingface:mainfrom
ricalanis:update_falconmamba_card
Apr 7, 2025
Merged

Update falcon mamba card#37253
stevhliu merged 7 commits intohuggingface:mainfrom
ricalanis:update_falconmamba_card

Conversation

@ricalanis
Copy link
Copy Markdown
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
Copy link
Copy Markdown
Contributor

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
Closed
stevhliu
stevhliu approved these changes Apr 3, 2025
View reviewed changes
Copy link
Copy Markdown
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! 🤩

Comment thread docs/source/en/model_doc/falcon_mamba.md Outdated

# FalconMamba

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

@stevhliu stevhliu Apr 3, 2025

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
Copy Markdown
Contributor Author

@ricalanis ricalanis Apr 3, 2025

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.

Comment thread docs/source/en/model_doc/falcon_mamba.md Outdated
Comment thread docs/source/en/model_doc/falcon_mamba.md Outdated
Comment thread docs/source/en/model_doc/falcon_mamba.md Outdated
ricalanis and others added 4 commits April 3, 2025 17:06
@ricalanis @stevhliu
Update docs/source/en/model_doc/falcon_mamba.md
470a91f 
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
@ricalanis @stevhliu
Update docs/source/en/model_doc/falcon_mamba.md
2c66026 
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
@ricalanis @stevhliu
Update docs/source/en/model_doc/falcon_mamba.md
3aabecc 
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
@ricalanis
fix: add right indent for tags
89e818e
@ricalanis
Copy link
Copy Markdown
Contributor Author

ricalanis commented Apr 3, 2025

Fixed comments, ready for review.

@HuggingFaceDocBuilderDev
Copy link
Copy Markdown

HuggingFaceDocBuilderDev commented Apr 4, 2025

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
Copy Markdown
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!

Comment thread 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
Copy Markdown
Member

@stevhliu stevhliu Apr 4, 2025

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
Copy Markdown
Contributor Author

@ricalanis ricalanis Apr 5, 2025

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 <59462357+stevhliu@users.noreply.github.com>

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

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

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

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* fix: add right indent for tags

* fix: remove notas

---------

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
cyr0930 pushed a commit to cyr0930/transformers that referenced this pull request Apr 18, 2025
@ricalanis @stevhliu
Update falcon mamba card (huggingface#37253)
f3a3b7e 
* 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 <59462357+stevhliu@users.noreply.github.com>

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

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

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

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* fix: add right indent for tags

* fix: remove notas

---------

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
zucchini-nlp pushed a commit to zucchini-nlp/transformers that referenced this pull request May 14, 2025
@ricalanis @stevhliu @zucchini-nlp
Update falcon mamba card (huggingface#37253)
2707091 
* 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 <59462357+stevhliu@users.noreply.github.com>

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

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

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

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* fix: add right indent for tags

* fix: remove notas

---------

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
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