-
Notifications
You must be signed in to change notification settings - Fork 33.1k
Add SAM3-LiteText #44320
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 SAM3-LiteText #44320
Changes from all commits
Commits
Show all changes
36 commits
Select commit
Hold shift + click to select a range
4bae67b
Fix
NielsRogge 2c96661
First draft
NielsRogge 490ff1f
Add push-to-hub options for SAM3-LiteText conversion
NielsRogge 00777a5
Merge pull request #69 from NielsRogge/codex/add-sam3-litetext-model-…
NielsRogge 4dd3735
Fix SAM3-LiteText model tests and text encoder init stability
NielsRogge 0d96394
Add LiteText ViT auto mappings and use LiteText config
NielsRogge 06fbf45
Merge branch 'add_sam_3_lite_text' into codex/add-sam3-litetext-model…
NielsRogge 53f7dd4
Merge pull request #70 from NielsRogge/codex/add-sam3-litetext-model-…
NielsRogge 4d8008a
Improve conversion script
NielsRogge a5ce4ca
Do not require triton
NielsRogge db44153
Improve modeling
NielsRogge 98cea30
Fix repo
NielsRogge 5fdc242
Merge remote-tracking branch 'upstream/main' into add_sam_3_lite_text
NielsRogge dcaceff
Merge remote-tracking branch 'upstream/main' into add_sam_3_lite_text
NielsRogge c85571e
Fix repo
NielsRogge 8ba6455
Merge branch 'main' into add_sam_3_lite_text
NielsRogge 5ab59a6
Add vision model to auto mapping
NielsRogge d5728ae
Add missing entries to auto mapping
NielsRogge 813dd0b
Merge remote-tracking branch 'upstream/main' into add_sam_3_lite_text
yonigozlan 583df21
reverse serve.py
yonigozlan 8f35675
simplify implementation
yonigozlan 37c3fcd
Merge remote-tracking branch 'upstream/main' into add_sam_3_lite_text
yonigozlan a402d1a
fix modular
yonigozlan 0ae1024
Merge branch 'main' into add_sam_3_lite_text
NielsRogge 672424a
Address review comments
yonigozlan 0b477d9
fix repo
yonigozlan ac3370a
fix after review 2
yonigozlan 7204251
Merge remote-tracking branch 'upstream/main' into add_sam_3_lite_text
yonigozlan 9baf14d
fix tests + repo
yonigozlan 5aaad48
Merge branch 'main' into add_sam_3_lite_text
yonigozlan c5deac2
Merge remote-tracking branch 'upstream/main' into add_sam_3_lite_text
NielsRogge fe153ad
Address comments
NielsRogge a1a9c1e
Address comments
NielsRogge 6ffbc8e
Make fix-repo
NielsRogge 9570b50
Merge branch 'main' into add_sam_3_lite_text
NielsRogge ccb4902
add to hub cache + fixup base sam3 as well
vasqu 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
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,118 @@ | ||
| <!--Copyright 2026 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. | ||
|
|
||
| --> | ||
| *This model was released on 2026-02-12 and added to Hugging Face Transformers on 2026-04-12.* | ||
|
|
||
| # SAM3-LiteText | ||
|
|
||
| <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"> | ||
| </div> | ||
| </div> | ||
|
|
||
| ## Overview | ||
|
|
||
| SAM3-LiteText was proposed in [SAM3-LiteText: An Anatomical Study of the SAM3 Text Encoder for Efficient Vision-Language Segmentation](https://huggingface.co/papers/2602.12173) by Chengxi Zeng, Yuxuan Jiang, Ge Gao, Shuai Wang, Duolikun Danier, Bin Zhu, Stevan Rudinac, David Bull, and Fan Zhang. | ||
|
|
||
| SAM3-LiteText is a lightweight variant of [SAM3](sam3) that replaces the heavy SAM3 text encoder (353M parameters) with a compact MobileCLIP-based text encoder optimized through knowledge distillation. The SAM3 ViT-H image encoder is kept intact. This reduces text encoder parameters by up to 88% while maintaining segmentation performance comparable to the original model. | ||
|
|
||
| The abstract from the paper is the following: | ||
|
|
||
| *Vision-language segmentation models such as SAM3 enable flexible, prompt-driven visual grounding, but inherit large, general-purpose text encoders originally designed for open-ended language understanding. In practice, segmentation prompts are short, structured, and semantically constrained, leading to substantial over-provisioning in text encoder capacity and persistent computational and memory overhead. In this paper, we perform a large-scale anatomical analysis of text prompting in vision-language segmentation, covering 404,796 real prompts across multiple benchmarks. Our analysis reveals severe redundancy: most context windows are underutilized, vocabulary usage is highly sparse, and text embeddings lie on low-dimensional manifold despite high-dimensional representations. Motivated by these findings, we propose SAM3-LiteText, a lightweight text encoding framework that replaces the original SAM3 text encoder with a compact MobileCLIP student that is optimized by knowledge distillation. Extensive experiments on image and video segmentation benchmarks show that SAM3-LiteText reduces text encoder parameters by up to 88%, substantially reducing static memory footprint, while maintaining segmentation performance comparable to the original model.* | ||
|
|
||
| The text encoder architecture is based on [MobileCLIP](https://huggingface.co/papers/2311.17049) and comes in three variants: | ||
|
|
||
| | Variant | Text Encoder | Text Params | Reduction | | ||
| |---|---|---|---| | ||
| | SAM3-LiteText-S0-16 | MobileCLIP-S0 | 42.54M | ~88% | | ||
| | SAM3-LiteText-S1-16 | MobileCLIP-S1 | 63.53M | ~82% | | ||
| | SAM3-LiteText-L-16 | MobileCLIP2-L | 123.80M | ~65% | | ||
|
|
||
| This model was contributed by [nielsr](https://huggingface.co/nielsr) and [yonigozlan](https://huggingface.co/yonigozlan). | ||
| The original code can be found [here](https://github.com/SimonZeng7108/efficientsam3/tree/sam3_litetext). | ||
|
|
||
| ## Usage | ||
|
|
||
| SAM3-LiteText is a drop-in replacement for SAM3 with a lightweight text encoder. It uses the same processor ([`Sam3Processor`]) and supports the same prompting interface. Refer to the [SAM3 documentation](sam3) for detailed usage examples including text prompts, box prompts, batched inference, and more. | ||
|
|
||
| ```python | ||
| from io import BytesIO | ||
|
|
||
| import httpx | ||
| from transformers import AutoModel, AutoProcessor | ||
| from PIL import Image | ||
|
|
||
| model = AutoModel.from_pretrained("yonigozlan/sam3-litetext-s0", device_map="auto") | ||
| processor = AutoProcessor.from_pretrained("yonigozlan/sam3-litetext-s0") | ||
|
Comment on lines
+61
to
+62
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Are there any plans to move these to another repo? |
||
|
|
||
| image_url = "http://images.cocodataset.org/val2017/000000077595.jpg" | ||
| image = Image.open(BytesIO(httpx.get(image_url).content)).convert("RGB") | ||
|
|
||
| inputs = processor(images=image, text="ear", return_tensors="pt").to(model.device) | ||
|
|
||
| outputs = model(**inputs) | ||
|
|
||
| results = processor.post_process_instance_segmentation( | ||
| outputs, | ||
| threshold=0.5, | ||
| mask_threshold=0.5, | ||
| target_sizes=inputs.get("original_sizes").tolist(), | ||
| )[0] | ||
|
|
||
| print(f"Found {len(results['masks'])} objects") | ||
| ``` | ||
|
|
||
| ## Sam3LiteTextConfig | ||
|
|
||
| [[autodoc]] Sam3LiteTextConfig | ||
|
|
||
| ## Sam3LiteTextTextConfig | ||
|
|
||
| [[autodoc]] Sam3LiteTextTextConfig | ||
|
|
||
|
vasqu marked this conversation as resolved.
|
||
| ## Sam3LiteTextGeometryEncoderConfig | ||
|
|
||
| [[autodoc]] Sam3LiteTextGeometryEncoderConfig | ||
|
|
||
| ## Sam3LiteTextDETREncoderConfig | ||
|
|
||
| [[autodoc]] Sam3LiteTextDETREncoderConfig | ||
|
|
||
| ## Sam3LiteTextDETRDecoderConfig | ||
|
|
||
| [[autodoc]] Sam3LiteTextDETRDecoderConfig | ||
|
|
||
| ## Sam3LiteTextMaskDecoderConfig | ||
|
|
||
| [[autodoc]] Sam3LiteTextMaskDecoderConfig | ||
|
|
||
| ## Sam3LiteTextTextModel | ||
|
|
||
| [[autodoc]] Sam3LiteTextTextModel | ||
| - forward | ||
|
|
||
| ## Sam3LiteTextModel | ||
|
|
||
| [[autodoc]] Sam3LiteTextModel | ||
| - forward | ||
|
|
||
| ## Sam3LiteTextPreTrainedModel | ||
|
|
||
| [[autodoc]] Sam3LiteTextPreTrainedModel | ||
| - 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
|
yonigozlan marked this conversation as resolved.
|
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
|
vasqu marked this conversation as resolved.
|
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
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,28 @@ | ||
| # Copyright 2026 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. | ||
|
|
||
| from typing import TYPE_CHECKING | ||
|
|
||
| from ...utils import _LazyModule | ||
| from ...utils.import_utils import define_import_structure | ||
|
|
||
|
|
||
| if TYPE_CHECKING: | ||
| from .configuration_sam3_lite_text import * | ||
| from .modeling_sam3_lite_text import * | ||
| else: | ||
| import sys | ||
|
|
||
| _file = globals()["__file__"] | ||
| sys.modules[__name__] = _LazyModule(__name__, _file, define_import_structure(_file), module_spec=__spec__) |
Oops, something went wrong.
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.