Merge branch 'main' into refactor/folder3d

.github/ISSUE_TEMPLATE/epic.yaml

@@ -0,0 +1,39 @@
+name: 🎯 Epic
+description: A large body of work that can be broken down into smaller stories
+title: "🎯 [EPIC] "
+labels: ["epic"]
+assignees: []
+body:
+  - type: markdown
+    attributes:
+      value: "## 🎯 Epic Description"
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the epic
+      description: Provide a clear and concise description of what this epic encompasses
+    validations:
+      required: true
+  - type: textarea
+    id: goals
+    attributes:
+      label: Goals
+      description: What are the main goals of this epic?
+    validations:
+      required: true
+  - type: textarea
+    id: tasks
+    attributes:
+      label: Tasks
+      description: Break down the epic into smaller tasks. Add or remove tasks as needed.
+      value: |
+        - [ ] Task 1: 
+        - [ ] Task 2: 
+        - [ ] Task 3: 
+        - [ ] Task 4: 
+        - [ ] Task 5: 
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: "Remember to create separate issues for each task and link them to this epic."

.github/ISSUE_TEMPLATE/task.yaml

@@ -1,35 +1,65 @@
-name: Tasks
-description: This is used to capture tasks being implemented/to implement such as features, maintenance, refactor, etc.
-title: "[Task]: "
-labels: ["Task"]
+name: 📋 Task
+description: A specific piece of work to be completed
+title: "📋 [TASK] "
+labels: ["task"]
+assignees: []
 body:
   - type: markdown
     attributes:
-      value: |
-        We encourage our users to submit feature requests in our [Discussion forum](https://github.com/openvinotoolkit/anomalib/discussions/categories/ideas-feature-requests). You can use this template for consistency.
-
+      value: "## 📋 Task Description"
   - type: textarea
-    id: motivation
+    id: description
     attributes:
-      label: What is the motivation for this task?
-      description: A clear and concise description of what the problem is.
-      placeholder: |
-        1. I'm always frustrated when [...]. It would be better if we could [...]
-        2. I would like to have [...] model/dataset to be supported in Anomalib.
+      label: Describe the task
+      description: Provide a clear and concise description of the task to be completed
     validations:
       required: true
   - type: textarea
-    id: solution
+    id: acceptance-criteria
     attributes:
-      label: Describe the solution you'd like
-      description: A clear and concise description of what you want to happen. Add screenshots or code-blocks if necessary.
-      placeholder: |
-        I would like to have [...] to do this we would need to [...]
-        Here is what I would like to see [...]
+      label: Acceptance Criteria
+      description: List the specific criteria that must be met for this task to be considered complete
+    validations:
+      required: true
+  - type: dropdown
+    id: priority
+    attributes:
+      label: Priority
+      options:
+        - Low
+        - Medium
+        - High
+    validations:
+      required: true
+  - type: input
+    id: epic-link
+    attributes:
+      label: Related Epic
+      description: If this task is part of an epic, provide the epic's issue number (e.g., #123)
+    validations:
+      required: false
+  - type: input
+    id: estimated-time
+    attributes:
+      label: Estimated Time
+      description: Provide an estimate of how long this task will take (e.g., 2h, 1d)
+    validations:
+      required: false
+  - type: dropdown
+    id: status
+    attributes:
+      label: Current Status
+      options:
+        - Not Started
+        - In Progress
+        - Blocked
+        - Ready for Review
     validations:
       required: true
   - type: textarea
-    id: additional-context
+    id: additional-info
     attributes:
-      label: Additional context
-      description: Add any other context or screenshots about the feature request here.
+      label: Additional Information
+      description: Any other relevant details or context for this task
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/user_story.yaml

@@ -0,0 +1,69 @@
+name: 📖 User Story
+description: A small, self-contained unit of development work describing a feature from an end-user perspective
+title: "📖 [STORY] "
+labels: ["user-story"]
+assignees: []
+body:
+  - type: markdown
+    attributes:
+      value: "## 📖 User Story Description"
+  - type: textarea
+    id: user-story
+    attributes:
+      label: User Story
+      description: As a [type of user], I want [an action] so that [a benefit/a value]
+      placeholder: As a computer vision researcher, I want to implement a new anomaly detection algorithm so that I can improve detection accuracy for industrial defect scenarios.
+    validations:
+      required: true
+  - type: textarea
+    id: acceptance-criteria
+    attributes:
+      label: Acceptance Criteria
+      description: List the acceptance criteria for this user story
+      placeholder: |
+        1. The new algorithm is implemented and integrated into the anomalib framework
+        2. Unit tests are written and pass for the new implementation
+        3. Performance benchmarks show improvement over existing methods on specified datasets
+        4. Documentation is updated to include usage instructions and theory behind the new algorithm
+        5. An example notebook is provided demonstrating the algorithm's application
+    validations:
+      required: true
+  - type: input
+    id: story-points
+    attributes:
+      label: Story Points
+      description: Estimate the complexity of this story (e.g., 1, 2, 3, 5, 8, 13)
+    validations:
+      required: true
+  - type: input
+    id: epic-link
+    attributes:
+      label: Related Epic
+      description: If this story is part of an epic, provide the epic's issue number (e.g., #123)
+    validations:
+      required: false
+  - type: dropdown
+    id: model-category
+    attributes:
+      label: Category
+      description: Select the category this story primarily relates to
+      options:
+        - Data
+        - Anomaly Detection Algorithms
+        - Pre-processing
+        - Post-processing
+        - Evaluation Metrics
+        - Visualization
+        - Performance Optimization
+        - API/Interface
+        - Documentation
+        - Others
+    validations:
+      required: true
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional Context
+      description: Add any other context, background, or relevant research papers about the user story here
+    validations:
+      required: false

.pre-commit-config.yaml

@@ -15,7 +15,7 @@ repos:
 
   # Ruff version.
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: "v0.5.1"
+    rev: "v0.6.2"
     hooks:
       # Run the linter.
       - id: ruff
@@ -27,7 +27,7 @@ repos:
 
   # python static type checking
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: "v1.10.1"
+    rev: "v1.11.2"
     hooks:
       - id: mypy
         additional_dependencies: [types-PyYAML, types-setuptools]
@@ -43,7 +43,7 @@ repos:
 
   # notebooks.
   - repo: https://github.com/nbQA-dev/nbQA
-    rev: 1.8.5
+    rev: 1.8.7
     hooks:
       - id: nbqa-ruff
         # Ignore unsorted imports. This is because jupyter notebooks can import

CHANGELOG.md

@@ -8,6 +8,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ### Added
 
+- Add `AUPIMO` tutorials notebooks in https://github.com/openvinotoolkit/anomalib/pull/2330 and https://github.com/openvinotoolkit/anomalib/pull/2336
+- Add `AUPIMO` metric by [jpcbertoldo](https://github.com/jpcbertoldo) in https://github.com/openvinotoolkit/anomalib/pull/1726 and refactored by [ashwinvaidya17](https://github.com/ashwinvaidya17) in https://github.com/openvinotoolkit/anomalib/pull/2329
+
 ### Changed
 
 ### Deprecated

docs/requirements.txt

@@ -1,7 +1,7 @@
 myst-parser
 nbsphinx
 pandoc
-sphinx<8.0  # 7.0 breaks readthedocs builds.
+sphinx
 sphinx_autodoc_typehints
 sphinx_book_theme
 sphinx-copybutton

docs/source/conf.py

@@ -7,6 +7,9 @@
 https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 """
 
+# Copyright (C) 2022-2024 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+
 from __future__ import annotations
 
 import sys

notebooks/000_getting_started/001_getting_started.ipynb

@@ -168,7 +168,7 @@
     "from anomalib import TaskType\n",
     "from anomalib.data import MVTec\n",
     "from anomalib.data.utils import read_image\n",
-    "from anomalib.deploy import OpenVINOInferencer, ExportType\n",
+    "from anomalib.deploy import ExportType, OpenVINOInferencer\n",
     "from anomalib.engine import Engine\n",
     "from anomalib.models import Padim"
    ]