-
Notifications
You must be signed in to change notification settings - Fork 845
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
fix(doc): Update documentation with last added models and datasets #3181
Conversation
…cropping for visualization alignment
…efine model names
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.
Pull request overview
This PR updates the documentation to include recently added models (Dinomaly, UniNet, and Fuvas) and datasets (MPDD and 3DADAM) that were missing from various documentation files. Additionally, it includes implementation changes to the Dinomaly model to fix visualization alignment issues when center cropping is used.
Key Changes:
- Added documentation entries for Dinomaly and UniNet image models, and Fuvas video model
- Added documentation for MPDD (image) and ADAM 3D (depth) datasets
- Enhanced metrics documentation with comprehensive descriptions
- Implemented anomaly map "uncropping" in Dinomaly to align visualizations with pre-crop dimensions
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/anomalib/models/video/init.py | Added Fuvas model to module docstring |
| src/anomalib/models/image/dinomaly/torch_model.py | Implemented _uncrop_anomaly_map method and updated forward pass to handle center crop offset for visualization alignment |
| src/anomalib/models/image/dinomaly/lightning_model.py | Updated docstring to clarify preprocessing pipeline (448→392 crop) |
| src/anomalib/models/image/init.py | Added Dinomaly and UniNet to module docstring |
| src/anomalib/models/init.py | Added Dinomaly, UniNet, and Fuvas to main models module docstring |
| docs/source/markdown/guides/reference/models/video/index.md | Added Fuvas card and toctree entry |
| docs/source/markdown/guides/reference/models/video/fuvas.md | Created new documentation page for Fuvas model |
| docs/source/markdown/guides/reference/models/image/index.md | Added Dinomaly and UniNet cards and toctree entries |
| docs/source/markdown/guides/reference/metrics/index.md | Expanded metrics documentation with detailed descriptions and grid layout |
| docs/source/markdown/guides/reference/data/datamodules/image/mpdd.md | Created new documentation page for MPDD dataset |
| docs/source/markdown/guides/reference/data/datamodules/image.md | Added MPDD card and automodule entry |
| docs/source/markdown/guides/reference/data/datamodules/depth/index.md | Added ADAM 3D card and toctree entry |
| docs/source/markdown/guides/reference/data/datamodules/depth/adam_3d.md | Created new documentation page for ADAM 3D dataset |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Has some commits unrelated to title. Closing. Will reopen without those commits |
ashwinvaidya17
left a comment
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.
Thanks for the efforts
📝 Description
Some parts of documentation was not updated when we added new models (like Dinomaly and Uninet) and some datasets (like 3DADAM).
In this PR, make sure documentation is up to date with all the models and datasets we have in Anomalib.
Select what type of change your PR is:
✅ Checklist
Before you submit your pull request, please make sure you have completed the following steps:
For more information about code review checklists, see the Code Review Checklist.