-
Notifications
You must be signed in to change notification settings - Fork 841
feat(model): add DINOv2 official implementation and AnomalyDINO #3105
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
Open
alfieroddanintel
wants to merge
17
commits into
open-edge-platform:main
Choose a base branch
from
alfieroddanintel:feat/model/AnomalyDINO
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
a582d13
init commit
alfieroddanintel 08e722a
add cdist instead of euclidean distance, divide by 2 for cosine and iβ¦
alfieroddanintel 1a92038
remove redundant euclidean distance
alfieroddanintel 5cfd65c
Add AnomalyDINO to model list. Also alphabetically re-order some models
alfieroddanintel 6727541
add precision modifier
alfieroddanintel 822f8a3
remove fit comments. small typo of shape dimensions
alfieroddanintel 4753d08
update docs for anomaly dino
alfieroddanintel 6cf0d11
cleanup docstrings
alfieroddanintel 107432c
add unit tests for anomalydino. change distance computation from cdisβ¦
alfieroddanintel 4a4423f
add vit/dino implementation (no xformers). implement factory class foβ¦
alfieroddanintel d0c9c14
change dinov2loader to factory method, remove duplicated components fβ¦
alfieroddanintel e82da76
add from_name back
alfieroddanintel 42c2b2c
add tests for vit and dinov2loader
alfieroddanintel 0739df4
update docstrings
alfieroddanintel 826c18c
fix(accelerator): Adding name method in XPUAccelerator (#3108)
waschsalz 0788a32
change licesning with meta. Tensor is torch.Tensor. remove __future__.
alfieroddanintel 2d29e9a
Merge branch 'main' into feat/model/AnomalyDINO
alfieroddanintel 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
13 changes: 13 additions & 0 deletions
13
docs/source/markdown/guides/reference/models/image/anomaly_dino.md
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,13 @@ | ||
| # AnomalyDINO | ||
|
|
||
| ```{eval-rst} | ||
| .. automodule:: anomalib.models.image.anomaly_dino.lightning_model | ||
| :members: AnomalyDINO | ||
| :show-inheritance: | ||
| ``` | ||
|
|
||
| ```{eval-rst} | ||
| .. automodule:: anomalib.models.image.anomaly_dino.torch_model | ||
| :members: AnomalyDINOModel | ||
| :show-inheritance: | ||
| ``` |
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,7 @@ | ||
| model: | ||
| class_path: anomalib.models.AnomalyDINO | ||
| init_args: | ||
| num_neighbours: 1 | ||
| encoder_name: dinov2_vit_small_14 | ||
| masking: False | ||
| coreset_subsampling: False |
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,35 @@ | ||
| # Copyright (C) 2025 Intel Corporation | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
|
|
||
| """Anomalib's Vision Transformer implementation. | ||
|
|
||
| References: | ||
| https://github.com/facebookresearch/dinov2/blob/main/dinov2/ | ||
|
|
||
| Classes: | ||
| DinoVisionTransformer: DINOv2 implementation. | ||
| DinoV2Loader: Loader class to support downloading and loading weights. | ||
| """ | ||
|
|
||
| # vision transformer | ||
| # loader | ||
| from .dinov2_loader import DinoV2Loader | ||
| from .vision_transformer import ( | ||
| DinoVisionTransformer, | ||
| vit_base, | ||
| vit_giant2, | ||
| vit_large, | ||
| vit_small, | ||
| ) | ||
|
|
||
| __all__ = [ | ||
| # vision transformer | ||
| "DinoVisionTransformer", | ||
| "vit_base", | ||
| "vit_giant2", | ||
| "vit_large", | ||
| "vit_small", | ||
| # loader | ||
| "DinoV2Loader", | ||
| ] |
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,243 @@ | ||
| # Copyright (C) 2025 Intel Corporation | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| """Loading pre-trained DINOv2 Vision Transformer models. | ||
|
|
||
| This module provides the :class:`DinoV2Loader` class for constructing and loading | ||
| pre-trained DINOv2 Vision Transformer models used in the Dinomaly anomaly detection | ||
| framework. It supports both standard DINOv2 models and register-token variants, and | ||
| allows custom Vision Transformer factories to be supplied. | ||
|
|
||
| Example: | ||
| >>> from anomalib.models.components.dinov2 import DinoV2Loader | ||
| >>> loader = DinoV2Loader() | ||
| >>> model = loader.load("dinov2_vit_base_14") | ||
| >>> model = loader.load("vit_base_14") | ||
| >>> custom_loader = DinoV2Loader(vit_factory=my_custom_vit_module) | ||
| >>> model = custom_loader.load("dinov2reg_vit_base_14") | ||
|
|
||
| The DINOv2 loader handles: | ||
|
|
||
| - Parsing model names and validating architecture types | ||
| - Constructing the appropriate Vision Transformer model | ||
| - Locating or downloading the corresponding pre-trained weights | ||
| - Supporting custom ViT implementations via a pluggable factory | ||
|
|
||
| This enables a simple, unified interface for accessing DINOv2-based backbones in | ||
| downstream anomaly detection tasks. | ||
| """ | ||
|
|
||
| import logging | ||
| from pathlib import Path | ||
| from typing import ClassVar | ||
| from urllib.request import urlretrieve | ||
|
|
||
| import torch | ||
|
|
||
| from anomalib.data.utils import DownloadInfo | ||
| from anomalib.data.utils.download import DownloadProgressBar | ||
| from anomalib.models.components.dinov2 import vision_transformer as dinov2_models | ||
|
|
||
| logger = logging.getLogger(__name__) | ||
|
|
||
| MODEL_FACTORIES: dict[str, object] = { | ||
| "dinov2": dinov2_models, | ||
| "dinov2_reg": dinov2_models, | ||
| } | ||
|
|
||
|
|
||
| class DinoV2Loader: | ||
| """Simple loader for DINOv2 Vision Transformer models. | ||
|
|
||
| Supports loading dinov2, dinov2_reg, and dinomaly model variants across small, base, | ||
| and large architectures. | ||
| """ | ||
|
|
||
| DINOV2_BASE_URL: ClassVar[str] = "https://dl.fbaipublicfiles.com/dinov2" | ||
|
|
||
| MODEL_CONFIGS: ClassVar[dict[str, dict[str, int]]] = { | ||
| "small": {"embed_dim": 384, "num_heads": 6}, | ||
| "base": {"embed_dim": 768, "num_heads": 12}, | ||
| "large": {"embed_dim": 1024, "num_heads": 16}, | ||
| } | ||
|
|
||
| def __init__( | ||
| self, | ||
| cache_dir: str | Path = "./pre_trained/", | ||
| vit_factory: object | None = None, | ||
| ) -> None: | ||
| self.cache_dir = Path(cache_dir) | ||
| self.vit_factory = vit_factory | ||
| self.cache_dir.mkdir(parents=True, exist_ok=True) | ||
|
|
||
| def load(self, model_name: str) -> torch.nn.Module: | ||
| """Load a DINOv2 model by name. | ||
|
|
||
| Args: | ||
| model_name: Model identifier such as "dinov2_vit_base_14". | ||
|
|
||
| Returns: | ||
| A fully constructed and weight-loaded PyTorch module. | ||
|
|
||
| Raises: | ||
| ValueError: If the requested model name is malformed or unsupported. | ||
| """ | ||
| model_type, architecture, patch_size = self._parse_name(model_name) | ||
| model = self.create_model(model_type, architecture, patch_size) | ||
| self._load_weights(model, model_type, architecture, patch_size) | ||
|
|
||
| logger.info(f"Loaded model: {model_name}") | ||
| return model | ||
|
|
||
| @classmethod | ||
| def from_name( | ||
| cls, | ||
| model_name: str, | ||
| cache_dir: str | Path = "./pre_trained/", | ||
| ) -> torch.nn.Module: | ||
| """Instantiate a loader and return the requested model.""" | ||
| loader = cls(cache_dir) | ||
| return loader.load(model_name) | ||
|
|
||
| def _parse_name(self, name: str) -> tuple[str, str, int]: | ||
| """Parse a model name string into components. | ||
|
|
||
| Args: | ||
| name: Full model name string. | ||
|
|
||
| Returns: | ||
| Tuple of (model_type, architecture_name, patch_size). | ||
|
|
||
| Raises: | ||
| ValueError: If the prefix or architecture is unknown. | ||
| """ | ||
| parts = name.split("_") | ||
| prefix = parts[0] | ||
| architecture = parts[-2] | ||
| patch_size = int(parts[-1]) | ||
|
|
||
| if prefix == "dinov2reg": | ||
| model_type = "dinov2_reg" | ||
| elif prefix == "dinov2": | ||
| model_type = "dinov2" | ||
| elif prefix == "dinomaly": | ||
| model_type = "dinomaly" | ||
| else: | ||
| msg = f"Unknown model type prefix '{prefix}'." | ||
| raise ValueError(msg) | ||
|
|
||
| if architecture not in self.MODEL_CONFIGS: | ||
| msg = f"Invalid architecture '{architecture}'. Expected one of: {list(self.MODEL_CONFIGS)}" | ||
| raise ValueError( | ||
| msg, | ||
| ) | ||
|
|
||
| return model_type, architecture, patch_size | ||
|
|
||
| def create_model(self, model_type: str, architecture: str, patch_size: int) -> torch.nn.Module: | ||
| """Create a Vision Transformer model. | ||
|
|
||
| Args: | ||
| model_type: Normalized model family name (e.g., "dinov2", "dinov2_reg"). | ||
| architecture: Architecture size (e.g., "small", "base", "large"). | ||
| patch_size: ViT patch size. | ||
|
|
||
| Returns: | ||
| Instantiated Vision Transformer model. | ||
|
|
||
| Raises: | ||
| ValueError: If no matching constructor exists. | ||
| """ | ||
| model_kwargs = { | ||
| "patch_size": patch_size, | ||
| "img_size": 518, | ||
| "block_chunks": 0, | ||
| "init_values": 1e-8, | ||
| "interpolate_antialias": False, | ||
| "interpolate_offset": 0.1, | ||
| } | ||
|
|
||
| if model_type == "dinov2_reg": | ||
| model_kwargs["num_register_tokens"] = 4 | ||
|
|
||
| # If user supplied a custom ViT module, use it | ||
| module = self.vit_factory if self.vit_factory is not None else MODEL_FACTORIES[model_type] | ||
|
|
||
| ctor = getattr(module, f"vit_{architecture}", None) | ||
| if ctor is None: | ||
| msg = f"No constructor vit_{architecture} in module {module}" | ||
| raise ValueError(msg) | ||
|
|
||
| return ctor(**model_kwargs) | ||
|
|
||
| def _load_weights( | ||
| self, | ||
| model: torch.nn.Module, | ||
| model_type: str, | ||
| architecture: str, | ||
| patch_size: int, | ||
| ) -> None: | ||
| """Load pre-trained weights from disk, downloading them if necessary.""" | ||
| weight_path = self._get_weight_path(model_type, architecture, patch_size) | ||
|
|
||
| if not weight_path.exists(): | ||
| self._download_weights(model_type, architecture, patch_size) | ||
|
|
||
| # Using weights_only=True for safety mitigation (see Anomalib PR #2729) | ||
| state_dict = torch.load(weight_path, map_location="cpu", weights_only=True) # nosec B614 | ||
| model.load_state_dict(state_dict, strict=False) | ||
|
|
||
| def _get_weight_path( | ||
| self, | ||
| model_type: str, | ||
| architecture: str, | ||
| patch_size: int, | ||
| ) -> Path: | ||
| """Return the expected local path for downloaded weights.""" | ||
| arch_code = architecture[0] | ||
|
|
||
| if model_type == "dinov2_reg": | ||
| filename = f"dinov2_vit{arch_code}{patch_size}_reg4_pretrain.pth" | ||
| else: | ||
| filename = f"dinov2_vit{arch_code}{patch_size}_pretrain.pth" | ||
|
|
||
| return self.cache_dir / filename | ||
|
|
||
| def _download_weights( | ||
| self, | ||
| model_type: str, | ||
| architecture: str, | ||
| patch_size: int, | ||
| ) -> None: | ||
| """Download DINOv2 weight files using Anomalib's standardized utilities.""" | ||
| weight_path = self._get_weight_path(model_type, architecture, patch_size) | ||
| arch_code = architecture[0] | ||
|
|
||
| model_dir = f"dinov2_vit{arch_code}{patch_size}" | ||
| url = f"{self.DINOV2_BASE_URL}/{model_dir}/{weight_path.name}" | ||
|
|
||
| download_info = DownloadInfo( | ||
| name=f"DINOv2 {model_type} {architecture} weights", | ||
| url=url, | ||
| hashsum="", # DINOv2 publishes no official hash | ||
| filename=weight_path.name, | ||
| ) | ||
|
|
||
| logger.info( | ||
| f"Downloading DINOv2 weights: {weight_path.name} to {self.cache_dir}", | ||
| ) | ||
|
|
||
| self.cache_dir.mkdir(parents=True, exist_ok=True) | ||
|
|
||
| with DownloadProgressBar( | ||
| unit="B", | ||
| unit_scale=True, | ||
| miniters=1, | ||
| desc=download_info.name, | ||
| ) as progress_bar: | ||
| # nosemgrep: python.lang.security.audit.dynamic-urllib-use-detected.dynamic-urllib-use-detected # noqa: ERA001, E501 | ||
| urlretrieve( # noqa: S310 # nosec B310 | ||
| url=url, | ||
| filename=weight_path, | ||
| reporthook=progress_bar.update_to, | ||
| ) | ||
|
Comment on lines
+239
to
+243
Check warningCode scanning / Semgrep OSS Semgrep Finding: python.lang.security.audit.dynamic-urllib-use-detected.dynamic-urllib-use-detected Warning
Detected a dynamic value being used with urllib. urllib supports 'file://' schemes, so a dynamic value controlled by a malicious actor may allow them to read arbitrary files. Audit uses of urllib calls to ensure user data cannot control the URLs, or consider using the 'requests' library instead.
|
||
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.
Check failure
Code scanning / Semgrep OSS
Semgrep Finding: trailofbits.python.pickles-in-pytorch.pickles-in-pytorch Error