-
Notifications
You must be signed in to change notification settings - Fork 31.1k
Add SmolLM3 #38755
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
Merged
Merged
Add SmolLM3 #38755
Changes from 13 commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
b179a67
init smollm3
anton-l 7431070
integration tests
anton-l 70ce44f
config quirks
anton-l 6444427
docs stub
anton-l 73f1232
rests round 2
anton-l 95e2511
tests round 3
anton-l 985b297
tests round 4
anton-l 81d6f2c
bring SWA back
anton-l 5593214
config checker pls
anton-l 67b3b61
Merge branch 'main' into add-smollm3
anton-l e7361fa
final checkpoint
anton-l 83433ef
Merge branch 'main' into add-smollm3
anton-l 3c18d71
style and copies
anton-l 29adf71
Update src/transformers/models/smollm3/modular_smollm3.py
anton-l f3c35eb
Update src/transformers/models/smollm3/modular_smollm3.py
anton-l cf2ab7f
Merge branch 'main' into add-smollm3
anton-l e4ae3a9
style and copies
anton-l c5aa283
docs
anton-l 1359a70
Merge branch 'main' into add-smollm3
anton-l a68cd05
CI pls
anton-l f1cc817
Merge branch 'main' into add-smollm3
anton-l File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,173 @@ | ||
| <!--Copyright 2025 The HuggingFace Team. All rights reserved. | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with | ||
| the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on | ||
| an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the | ||
| specific language governing permissions and limitations under the License. | ||
|
|
||
| ⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be | ||
| rendered properly in your Markdown viewer. | ||
|
|
||
| --> | ||
|
|
||
| <div style="float: right;"> | ||
| <div class="flex flex-wrap space-x-1"> | ||
| <img alt="PyTorch" src="https://img.shields.io/badge/PyTorch-DE3412?style=flat&logo=pytorch&logoColor=white"> | ||
| <img alt="FlashAttention" src="https://img.shields.io/badge/%E2%9A%A1%EF%B8%8E%20FlashAttention-eae0c8?style=flat"> | ||
| <img alt="SDPA" src="https://img.shields.io/badge/SDPA-DE3412?style=flat&logo=pytorch&logoColor=white"> | ||
| </div> | ||
| </div> | ||
|
|
||
| # SmolLM3 | ||
|
|
||
| SmolLM3 is [TODO] | ||
|
|
||
| > [!TIP] | ||
| > Click on the SmolLM3 models in the right sidebar for more examples of how to apply SmolLM3 to different language tasks. | ||
|
|
||
| The example below demonstrates how to generate text with [`Pipeline`], [`AutoModel`], and from the command line using the instruction-tuned models. | ||
|
|
||
| <hfoptions id="usage"> | ||
| <hfoption id="Pipeline"> | ||
|
|
||
| ```python | ||
| import torch | ||
| from transformers import pipeline | ||
|
|
||
| pipe = pipeline( | ||
| task="text-generation", | ||
| model="HuggingFaceTB/SmolLM3-3B", | ||
| torch_dtype=torch.bfloat16, | ||
| device_map=0 | ||
| ) | ||
|
|
||
| messages = [ | ||
| {"role": "system", "content": "You are a helpful assistant."}, | ||
| {"role": "user", "content": "Tell me about yourself."}, | ||
| ] | ||
| outputs = pipe(messages, max_new_tokens=256, do_sample=True, temperature=0.7, top_k=50, top_p=0.95) | ||
| print(outputs[0]["generated_text"][-1]['content']) | ||
| ``` | ||
|
|
||
| </hfoption> | ||
| <hfoption id="AutoModel"> | ||
|
|
||
| ```python | ||
| import torch | ||
| from transformers import AutoModelForCausalLM, AutoTokenizer | ||
|
|
||
| model = AutoModelForCausalLM.from_pretrained( | ||
| "HuggingFaceTB/SmolLM3-3B", | ||
| torch_dtype=torch.bfloat16, | ||
| device_map="auto", | ||
| attn_implementation="sdpa" | ||
| ) | ||
| tokenizer = AutoTokenizer.from_pretrained("HuggingFaceTB/SmolLM3-3B") | ||
|
|
||
| prompt = "Give me a short introduction to large language models." | ||
| messages = [ | ||
| {"role": "system", "content": "You are a helpful assistant."}, | ||
| {"role": "user", "content": prompt} | ||
| ] | ||
| text = tokenizer.apply_chat_template( | ||
| messages, | ||
| tokenize=False, | ||
| add_generation_prompt=True | ||
| ) | ||
| model_inputs = tokenizer([text], return_tensors="pt").to("cuda") | ||
|
|
||
| generated_ids = model.generate( | ||
| model_inputs.input_ids, | ||
| cache_implementation="static", | ||
| max_new_tokens=512, | ||
| do_sample=True, | ||
| temperature=0.7, | ||
| top_k=50, | ||
| top_p=0.95 | ||
| ) | ||
| generated_ids = [ | ||
| output_ids[len(input_ids):] for input_ids, output_ids in zip(model_inputs.input_ids, generated_ids) | ||
| ] | ||
|
|
||
| response = tokenizer.batch_decode(generated_ids, skip_special_tokens=True)[0] | ||
| print(response) | ||
| ``` | ||
|
|
||
| </hfoption> | ||
| <hfoption id="transformers CLI"> | ||
|
|
||
| ```bash | ||
| # pip install -U flash-attn --no-build-isolation | ||
| transformers chat HuggingFaceTB/SmolLM3-3B --torch_dtype auto --attn_implementation flash_attention_2 --device 0 | ||
| ``` | ||
|
|
||
| </hfoption> | ||
| </hfoptions> | ||
|
|
||
| Quantization reduces the memory burden of large models by representing the weights in a lower precision. Refer to the [Quantization](../quantization/overview) overview for more available quantization backends. | ||
|
|
||
| The example below uses [bitsandbytes](../quantization/bitsandbytes) to quantize the weights to 4-bits. | ||
|
|
||
| ```python | ||
| # pip install -U flash-attn --no-build-isolation | ||
| import torch | ||
| from transformers import AutoTokenizer, AutoModelForCausalLM, BitsAndBytesConfig | ||
|
|
||
| quantization_config = BitsAndBytesConfig( | ||
| load_in_4bit=True, | ||
| bnb_4bit_compute_dtype=torch.bfloat16, | ||
| bnb_4bit_quant_type="nf4", | ||
| bnb_4bit_use_double_quant=True, | ||
| ) | ||
|
|
||
| tokenizer = AutoTokenizer.from_pretrained("HuggingFaceTB/SmolLM3-3B") | ||
| model = AutoModelForCausalLM.from_pretrained( | ||
| "HuggingFaceTB/SmolLM3-3B", | ||
| torch_dtype=torch.bfloat16, | ||
| device_map="auto", | ||
| quantization_config=quantization_config, | ||
| attn_implementation="flash_attention_2" | ||
| ) | ||
|
|
||
| inputs = tokenizer("Gravity is the force", return_tensors="pt").to("cuda") | ||
| outputs = model.generate(**inputs, max_new_tokens=100) | ||
| print(tokenizer.decode(outputs[0], skip_special_tokens=True)) | ||
| ``` | ||
|
|
||
|
|
||
| ## Notes | ||
|
|
||
| - Ensure your Transformers library version is up-to-date. SmolLM3 requires Transformers>=4.53.0 for full support. | ||
|
|
||
| ## SmolLM3Config | ||
|
|
||
| [[autodoc]] SmolLM3Config | ||
|
|
||
| ## SmolLM3Model | ||
|
|
||
| [[autodoc]] SmolLM3Model | ||
| - forward | ||
|
|
||
| ## SmolLM3ForCausalLM | ||
|
|
||
| [[autodoc]] SmolLM3ForCausalLM | ||
| - forward | ||
|
|
||
| ## SmolLM3ForSequenceClassification | ||
|
|
||
| [[autodoc]] SmolLM3ForSequenceClassification | ||
| - forward | ||
|
|
||
| ## SmolLM3ForTokenClassification | ||
|
|
||
| [[autodoc]] SmolLM3ForTokenClassification | ||
| - forward | ||
|
|
||
| ## SmolLM3ForQuestionAnswering | ||
|
|
||
| [[autodoc]] SmolLM3ForQuestionAnswering | ||
| - forward | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # Copyright 2025 The HuggingFace Inc. team. All rights reserved. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| from typing import TYPE_CHECKING | ||
|
|
||
| from ...utils import _LazyModule | ||
| from ...utils.import_utils import define_import_structure | ||
|
|
||
|
|
||
| if TYPE_CHECKING: | ||
| from .configuration_smollm3 import * | ||
| from .modeling_smollm3 import * | ||
| else: | ||
| import sys | ||
|
|
||
| _file = globals()["__file__"] | ||
| sys.modules[__name__] = _LazyModule(__name__, _file, define_import_structure(_file), module_spec=__spec__) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.