Update falcon model card by ricalanis · Pull Request #37184 · huggingface/transformers

ricalanis · 2025-04-01T19:11:31Z

Updated the Falcon model card
Did not update Falcon3 as it is not explicitly listed, but can do it also
Did not include the attention visualizer as I was not able to implement it for Falcon models in a straightforward way.
First contrib, thank you 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 · 2025-04-01T19:11:45Z

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.

stevhliu

Great work! 🚀

stevhliu · 2025-04-01T22:34:43Z

+<hfoption id="Pipeline">
+
+```py
+from transformers import pipeline


Can do this:

import torch from transformers import pipeline pipeline = pipeline( task="text-generation", model="tiiuae/falcon-7b-instruct", torch_dtype=torch.bfloat16, device=0 ) pipeline( "Write a short poem about coding", max_length=100, do_sample=True, temperature=0.7 )

stevhliu · 2025-04-01T22:44:16Z

+- Falcon models come in different sizes (7B, 40B, 180B parameters) and variants (base and instruct).
+- The "instruct" versions have been fine-tuned on instruction data and are better for conversational or instruction-following tasks.
+- For most applications, using FlashAttention or SDPA optimization is recommended for the best performance.
+- If you're upgrading from an older custom code checkpoint, remember to convert it to the official Transformers format using the conversion script located in the


Add snippet under here for using the script

Suggested change

- If you're upgrading from an older custom code checkpoint, remember to convert it to the official Transformers format using the conversion script located in the

- If you're upgrading from an older custom code checkpoint, remember to convert it to the official Transformers format for better stability and performance using the conversion script located in the

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

ricalanis · 2025-04-01T23:13:02Z

Thank you for your kind suggestions, @stevhliu. Added all of them, so ready for you to review again.

HuggingFaceDocBuilderDev · 2025-04-02T18:05:45Z

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.

ricalanis · 2025-04-02T19:51:08Z

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.

Thanks to this build i was able to spot a typo. Fixed.

stevhliu

Thanks, just two more minor changes and we can merge! 🔥

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

* feat: updated model card for falcon * fix:rewrite model description * fix: add link to conversion script * Update docs/source/en/model_doc/falcon.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update docs/source/en/model_doc/falcon.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update docs/source/en/model_doc/falcon.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update docs/source/en/model_doc/falcon.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update docs/source/en/model_doc/falcon.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update docs/source/en/model_doc/falcon.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update docs/source/en/model_doc/falcon.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update docs/source/en/model_doc/falcon.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * fix: Add suggested changes * fix: typo in link for quantization * Update docs/source/en/model_doc/falcon.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * Update docs/source/en/model_doc/falcon.md Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> * fix: fix indent and close ticks * fix: add indent --------- Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

ricalanis added 2 commits April 1, 2025 13:00

feat: updated model card for falcon

6fdb1c7

fix:rewrite model description

8a5d30a

github-actions Bot marked this pull request as draft April 1, 2025 19:11

ricalanis marked this pull request as ready for review April 1, 2025 19:13

github-actions Bot requested a review from stevhliu April 1, 2025 19:13

fix: add link to conversion script

88ee823

stevhliu mentioned this pull request Apr 1, 2025

[Community contributions] Model cards #36979

Closed

stevhliu reviewed Apr 1, 2025

View reviewed changes

ricalanis and others added 9 commits April 1, 2025 16:58

Update docs/source/en/model_doc/falcon.md

93bf854

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

Update docs/source/en/model_doc/falcon.md

7095089

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

Update docs/source/en/model_doc/falcon.md

1027977

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

Update docs/source/en/model_doc/falcon.md

a26f1af

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

Update docs/source/en/model_doc/falcon.md

9d7ebb8

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

Update docs/source/en/model_doc/falcon.md

95aa2dd

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

Update docs/source/en/model_doc/falcon.md

f8017d4

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

Update docs/source/en/model_doc/falcon.md

49c1cea

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

fix: Add suggested changes

40ab6ea

fix: typo in link for quantization

5985dd5

stevhliu approved these changes Apr 2, 2025

View reviewed changes

Comment thread docs/source/en/model_doc/falcon.md

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

ricalanis and others added 4 commits April 2, 2025 16:54

Update docs/source/en/model_doc/falcon.md

8a9b229

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

Update docs/source/en/model_doc/falcon.md

532b997

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

fix: fix indent and close ticks

7116c86

fix: add indent

a1d8bcd

stevhliu merged commit 3e96a0c into huggingface:main Apr 3, 2025
10 checks passed

	- If you're upgrading from an older custom code checkpoint, remember to convert it to the official Transformers format using the conversion script located in the
	- If you're upgrading from an older custom code checkpoint, remember to convert it to the official Transformers format for better stability and performance using the conversion script located in the

Conversation

ricalanis commented Apr 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Before submitting

Uh oh!

github-actions Bot commented Apr 1, 2025

Uh oh!

stevhliu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stevhliu Apr 1, 2025

Choose a reason for hiding this comment

Uh oh!

ricalanis Apr 1, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stevhliu Apr 1, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ricalanis commented Apr 1, 2025

Uh oh!

HuggingFaceDocBuilderDev commented Apr 2, 2025

Uh oh!

ricalanis commented Apr 2, 2025

Uh oh!

stevhliu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ricalanis commented Apr 1, 2025 •

edited

Loading