-
Notifications
You must be signed in to change notification settings - Fork 846
fix(doc): Update documentation with last added models and datasets #3181
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
ashwinvaidya17
merged 8 commits into
open-edge-platform:main
from
rajeshgangireddy:fixes/doc_update_01
Dec 3, 2025
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
3a99863
fix(dinomaly): remove center cropping to resolve visualization misaliβ¦
rajeshgangireddy c795975
Merge branch 'main' into fixes/dinomaly_centercrop
rajeshgangireddy aeb6109
fix(dinomaly): reintroduce center cropping with proper anomaly map unβ¦
rajeshgangireddy 7550475
Merge branch 'main' into fixes/dinomaly_centercrop
rajeshgangireddy 287492a
feat(docs): update documentation for new models and datasets
rajeshgangireddy c68a6b9
fix(docs): update descriptions for depth and image datamodules, and rβ¦
rajeshgangireddy 380e962
fix(docs): restore unrelated changes
rajeshgangireddy e3e2619
Merge branch 'main' into fixes/doc_update_01
rajeshgangireddy 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
8 changes: 8 additions & 0 deletions
8
docs/source/markdown/guides/reference/data/datamodules/depth/adam_3d.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,8 @@ | ||
| # ADAM3D | ||
|
|
||
| ```{eval-rst} | ||
| .. automodule:: anomalib.data.datamodules.depth.adam_3d | ||
| :members: | ||
| :undoc-members: | ||
| :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
8 changes: 8 additions & 0 deletions
8
docs/source/markdown/guides/reference/data/datamodules/image/mpdd.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,8 @@ | ||
| # MPDD | ||
|
|
||
| ```{eval-rst} | ||
| .. automodule:: anomalib.data.datamodules.image.mpdd | ||
| :members: | ||
| :undoc-members: | ||
| :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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,168 @@ | ||
| # Metrics | ||
|
|
||
| Anomalib provides a comprehensive set of metrics for evaluating anomaly detection model performance. All metrics extend TorchMetrics' functionality with Anomalib-specific features. | ||
|
|
||
| ## Available Metrics | ||
|
|
||
| ### Area Under Curve Metrics | ||
|
|
||
| ::::{grid} 2 | ||
| :gutter: 2 | ||
|
|
||
| :::{grid-item-card} AUROC | ||
| :link: anomalib.metrics.AUROC | ||
| :link-type: doc | ||
|
|
||
| Area Under the Receiver Operating Characteristic curve. Measures the model's ability to distinguish between normal and anomalous samples. | ||
| ::: | ||
|
|
||
| :::{grid-item-card} AUPR | ||
| :link: anomalib.metrics.AUPR | ||
| :link-type: doc | ||
|
|
||
| Area Under the Precision-Recall curve. Particularly useful for imbalanced datasets. | ||
| ::: | ||
|
|
||
| :::{grid-item-card} AUPRO | ||
| :link: anomalib.metrics.AUPRO | ||
| :link-type: doc | ||
|
|
||
| Area Under the Per-Region Overlap curve. Evaluates pixel-level anomaly localization performance. | ||
| ::: | ||
|
|
||
| :::{grid-item-card} AUPIMO | ||
| :link: anomalib.metrics.AUPIMO | ||
| :link-type: doc | ||
|
|
||
| Area Under the Per-Image Missed Overlap curve. Advanced metric for evaluating localization quality. | ||
| ::: | ||
|
|
||
| :::: | ||
|
|
||
| ### F1 Score Metrics | ||
|
|
||
| ::::{grid} 2 | ||
| :gutter: 2 | ||
|
|
||
| :::{grid-item-card} F1Score | ||
| :link: anomalib.metrics.F1Score | ||
| :link-type: doc | ||
|
|
||
| Standard F1 score for binary classification. Harmonic mean of precision and recall. | ||
| ::: | ||
|
|
||
| :::{grid-item-card} F1Max | ||
| :link: anomalib.metrics.F1Max | ||
| :link-type: doc | ||
|
|
||
| Maximum F1 score across all possible thresholds. Useful for finding optimal operating points. | ||
| ::: | ||
|
|
||
| :::: | ||
|
|
||
| ### Threshold Metrics | ||
|
|
||
| ::::{grid} 2 | ||
| :gutter: 2 | ||
|
|
||
| :::{grid-item-card} F1AdaptiveThreshold | ||
| :link: anomalib.metrics.F1AdaptiveThreshold | ||
| :link-type: doc | ||
|
|
||
| Automatically determines the optimal threshold by maximizing F1 score. | ||
| ::: | ||
|
|
||
| :::{grid-item-card} ManualThreshold | ||
| :link: anomalib.metrics.ManualThreshold | ||
| :link-type: doc | ||
|
|
||
| Uses a manually specified threshold for classification. | ||
| ::: | ||
|
|
||
| :::: | ||
|
|
||
| ### Other Metrics | ||
|
|
||
| ::::{grid} 2 | ||
| :gutter: 2 | ||
|
|
||
| :::{grid-item-card} PRO | ||
| :link: anomalib.metrics.PRO | ||
| :link-type: doc | ||
|
|
||
| Per-Region Overlap score for evaluating pixel-level localization. | ||
| ::: | ||
|
|
||
| :::{grid-item-card} PIMO | ||
| :link: anomalib.metrics.PIMO | ||
| :link-type: doc | ||
|
|
||
| Per-Image Missed Overlap for assessing localization errors. | ||
| ::: | ||
|
|
||
| :::{grid-item-card} PGn | ||
| :link: anomalib.metrics.PGn | ||
| :link-type: doc | ||
|
|
||
| Presorted Good with n% bad samples missed. Measures false negative rate at specific operating points. | ||
| ::: | ||
|
|
||
| :::{grid-item-card} PBn | ||
| :link: anomalib.metrics.PBn | ||
| :link-type: doc | ||
|
|
||
| Presorted Bad with n% good samples misclassified. Measures false positive rate at specific operating points. | ||
| ::: | ||
|
|
||
| :::{grid-item-card} MinMax | ||
| :link: anomalib.metrics.MinMax | ||
| :link-type: doc | ||
|
|
||
| Normalizes anomaly scores to [0, 1] range using min-max scaling. | ||
| ::: | ||
|
|
||
| :::{grid-item-card} AnomalyScoreDistribution | ||
| :link: anomalib.metrics.AnomalyScoreDistribution | ||
| :link-type: doc | ||
|
|
||
| Analyzes and tracks the distribution of anomaly scores for model diagnostics. | ||
| ::: | ||
|
|
||
| :::: | ||
|
|
||
| ### Utility Classes | ||
|
|
||
| ::::{grid} 2 | ||
| :gutter: 2 | ||
|
|
||
| :::{grid-item-card} AnomalibMetric | ||
| :link: anomalib.metrics.AnomalibMetric | ||
| :link-type: doc | ||
|
|
||
| Base class for all Anomalib metrics. Extends TorchMetrics with field-based updates. | ||
| ::: | ||
|
|
||
| :::{grid-item-card} Evaluator | ||
| :link: anomalib.metrics.Evaluator | ||
| :link-type: doc | ||
|
|
||
| Orchestrates multiple metrics for comprehensive model evaluation. | ||
| ::: | ||
|
|
||
| :::{grid-item-card} BinaryPrecisionRecallCurve | ||
| :link: anomalib.metrics.BinaryPrecisionRecallCurve | ||
| :link-type: doc | ||
|
|
||
| Computes precision-recall curves for binary classification tasks. | ||
| ::: | ||
|
|
||
| :::: | ||
|
|
||
| ## API Reference | ||
|
|
||
| ```{eval-rst} | ||
| .. automodule:: anomalib.metrics | ||
| :members: | ||
| :members: AUROC, AUPR, AUPRO, AUPIMO, F1Score, F1Max, F1AdaptiveThreshold, ManualThreshold, PRO, PIMO, PGn, PBn, MinMax, AnomalyScoreDistribution, AnomalibMetric, Evaluator, BinaryPrecisionRecallCurve, create_anomalib_metric | ||
| :undoc-members: | ||
| :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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # FUVAS | ||
|
|
||
| ```{eval-rst} | ||
| .. automodule:: anomalib.models.video.fuvas | ||
| :members: | ||
| :undoc-members: | ||
| :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
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
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.