Skip to content
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.

Sign up for GitHub

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

Jump to bottom

📋 [TASK] Add Documentation and Examples for AnomalibModule v2 #2370

Open
5 tasks
Tracked by #2364
samet-akcay opened this issue Oct 14, 2024 · 0 comments
Open
5 tasks
Tracked by #2364

📋 [TASK] Add Documentation and Examples for AnomalibModule v2 #2370

samet-akcay opened this issue Oct 14, 2024 · 0 comments
Milestone
v2.0.0

Comments

@samet-akcay
Copy link
Contributor

Describe the task

Create comprehensive documentation and usage examples for AnomalibModule and its components.

Acceptance Criteria

  • Write detailed API documentation for AnomalibModule and each auxiliary component
  • Provide usage examples for common anomaly detection scenarios
  • Create a migration guide from v1.x to v2.0.0
  • Include best practices and performance considerations
  • Update the main Anomalib documentation to reflect the new AnomalibModule design

Priority

High

Related Epic

#2364

Estimated Time

No response

Current Status

Not Started

Additional Information

No response
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
Anomalib
Status: 📝 To Do
Milestone
v2.0.0
Development

No branches or pull requests
1 participant
@samet-akcay