-
Notifications
You must be signed in to change notification settings - Fork 638
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
Anomalib CLI Improvements - Update metrics and create post_processing section in the config file #607
Merged
samet-akcay
merged 11 commits into
main
from
cli/sa/create-post-processing-section-in-configs
Oct 17, 2022
Merged
Anomalib CLI Improvements - Update metrics and create post_processing section in the config file #607
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
80f47b4
Rename image/pixel_metrics_names to image/pixel_metrics
samet-akcay 8039413
Rename image/pixel_metrics_names to image/pixel_metrics
samet-akcay 2e6b831
Modified config files.
samet-akcay 8dce79e
Modify get_callbacks function for the old cli
samet-akcay 508d469
Create pre-processing-configuration callback
samet-akcay e1a0671
Add new CLI configuration for the post-processing configuration
samet-akcay b9ae696
Add options to normalization_method
samet-akcay 00202c8
Address mypy issues
samet-akcay 54c9a39
Fix docstring
samet-akcay ba450f4
Fix merge conflicts
samet-akcay 838bd0b
Address codacy issues
samet-akcay 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 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 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 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,63 @@ | ||
"""Post-Processing Configuration Callback.""" | ||
|
||
# Copyright (C) 2022 Intel Corporation | ||
# SPDX-License-Identifier: Apache-2.0 | ||
|
||
|
||
import logging | ||
from typing import Optional | ||
|
||
import torch | ||
from pytorch_lightning import Callback, LightningModule, Trainer | ||
from pytorch_lightning.utilities.cli import CALLBACK_REGISTRY | ||
|
||
from anomalib.models.components.base.anomaly_module import AnomalyModule | ||
|
||
logger = logging.getLogger(__name__) | ||
|
||
__all__ = ["PostProcessingConfigurationCallback"] | ||
|
||
|
||
@CALLBACK_REGISTRY | ||
class PostProcessingConfigurationCallback(Callback): | ||
"""Post-Processing Configuration Callback. | ||
|
||
Args: | ||
normalization_method(Optional[str]): Normalization method. <None, min_max, cdf> | ||
adaptive_threshold (bool): Flag indicating whether threshold should be adaptive. | ||
default_image_threshold (Optional[float]): Default image threshold value. | ||
default_pixel_threshold (Optional[float]): Default pixel threshold value. | ||
""" | ||
|
||
def __init__( | ||
self, | ||
normalization_method: str = "min_max", | ||
adaptive_threshold: bool = True, | ||
default_image_threshold: Optional[float] = None, | ||
default_pixel_threshold: Optional[float] = None, | ||
) -> None: | ||
super().__init__() | ||
self.normalization_method = normalization_method | ||
|
||
assert ( | ||
adaptive_threshold or default_image_threshold is not None and default_pixel_threshold is not None | ||
), "Default thresholds must be specified when adaptive threshold is disabled." | ||
|
||
self.adaptive_threshold = adaptive_threshold | ||
self.default_image_threshold = default_image_threshold | ||
self.default_pixel_threshold = default_pixel_threshold | ||
|
||
# pylint: disable=unused-argument | ||
def setup(self, trainer: Trainer, pl_module: LightningModule, stage: Optional[str] = None) -> None: | ||
"""Setup post-processing configuration within Anomalib Model. | ||
|
||
Args: | ||
trainer (Trainer): PyTorch Lightning Trainer | ||
pl_module (LightningModule): Anomalib Model that inherits pl LightningModule. | ||
stage (Optional[str], optional): fit, validate, test or predict. Defaults to None. | ||
""" | ||
if isinstance(pl_module, AnomalyModule): | ||
pl_module.adaptive_threshold = self.adaptive_threshold | ||
if pl_module.adaptive_threshold is False: | ||
pl_module.image_threshold.value = torch.tensor(self.default_image_threshold).cpu() | ||
pl_module.pixel_threshold.value = torch.tensor(self.default_pixel_threshold).cpu() |
This file contains 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 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 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 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
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.
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.
We could consider replacing this parameter with a selectable called
thresholding_method
with the optionsfixed
andadaptive
. This might be a bit less confusing (for the unknowing reader,adaptive_threshold
could sound like it holds a threshold value). Later we could extend it withsynthetic
option.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.
I was also having a similar idea in my mind. I was not quite sure how exactly to address fixed image and pixel thresholds though
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.
It would be the equivalent of
adaptive_threshold: false
in the current implementationThere 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.
yeah, but let's say we set
thresholding_method
tofixed
. We would still need to setfixed_image_threshold
andfixed_pixel_threshold
, right?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.
yeah, but I don't see any problems with that. If users want to use a fixed threshold then they will have to provide a value for that. If they don't know which value to provide then they should just use the adaptive threshold.