-
Notifications
You must be signed in to change notification settings - Fork 28.6k
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.
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
Update falcon model card #37184
Update falcon model card #37184
Conversation
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work! 🚀
<hfoption id="Pipeline"> | ||
|
||
```py | ||
from transformers import pipeline |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added!
docs/source/en/model_doc/falcon.md
Outdated
- 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add snippet under here for using the script
- 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 <[email protected]>
Co-authored-by: Steven Liu <[email protected]>
Co-authored-by: Steven Liu <[email protected]>
Co-authored-by: Steven Liu <[email protected]>
Co-authored-by: Steven Liu <[email protected]>
Co-authored-by: Steven Liu <[email protected]>
Co-authored-by: Steven Liu <[email protected]>
Co-authored-by: Steven Liu <[email protected]>
Thank you for your kind suggestions, @stevhliu. Added all of them, so ready for you to review again. |
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, just two more minor changes and we can merge! 🔥
Co-authored-by: Steven Liu <[email protected]>
Co-authored-by: Steven Liu <[email protected]>
* 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 <[email protected]> * Update docs/source/en/model_doc/falcon.md Co-authored-by: Steven Liu <[email protected]> * Update docs/source/en/model_doc/falcon.md Co-authored-by: Steven Liu <[email protected]> * Update docs/source/en/model_doc/falcon.md Co-authored-by: Steven Liu <[email protected]> * Update docs/source/en/model_doc/falcon.md Co-authored-by: Steven Liu <[email protected]> * Update docs/source/en/model_doc/falcon.md Co-authored-by: Steven Liu <[email protected]> * Update docs/source/en/model_doc/falcon.md Co-authored-by: Steven Liu <[email protected]> * Update docs/source/en/model_doc/falcon.md Co-authored-by: Steven Liu <[email protected]> * fix: Add suggested changes * fix: typo in link for quantization * Update docs/source/en/model_doc/falcon.md Co-authored-by: Steven Liu <[email protected]> * Update docs/source/en/model_doc/falcon.md Co-authored-by: Steven Liu <[email protected]> * fix: fix indent and close ticks * fix: add indent --------- Co-authored-by: Steven Liu <[email protected]>
Fixes #36979
Before submitting
Pull Request section?
to it if that's the case.
documentation guidelines, and
here are tips on formatting docstrings.