📚Add how-to-guides and examples dir

.gitattributes

@@ -2,7 +2,6 @@
 * text=auto eol=lf
 *.{cmd,[cC][mM][dD]} text eol=crlf
 *.{bat,[bB][aA][tT]} text eol=crlf
-
 # Ignore *ipynb files to detect the language.
 # This is because GitHub misdetects the repo language when ipynb files are included.
-*.ipynb linguist-detectable=false
+*.ipynb filter=lfs diff=lfs merge=lfs -text

.github/CODEOWNERS

@@ -15,12 +15,12 @@
 /docs                                                       @samet-akcay
 
 # Notebooks
-/notebooks/000_getting_started                              @samet-akcay
-/notebooks/100_datamodules                                  @djdameln
-/notebooks/200_models                                       @samet-akcay
-/notebooks/300_benchmarking                                 @ashwinvaidya17
-/notebooks/400_openvino                                     @samet-akcay
-/notebooks/README.md                                        @samet-akcay
+/examples/notebooks/000_getting_started                              @samet-akcay
+/examples/notebooks/100_datamodules                                  @djdameln
+/examples/notebooks/200_models                                       @samet-akcay
+/examples/notebooks/300_benchmarking                                 @ashwinvaidya17
+/examples/notebooks/400_openvino                                     @samet-akcay
+/examples/notebooks/README.md                                        @samet-akcay
 
 # Requirements
 /requirements/                                              @samet-akcay @ashwinvaidya17 @djdameln

.github/workflows/_reusable-code-quality.yaml

@@ -62,6 +62,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
+          lfs: true
       - uses: ./.github/actions/code-quality/pre-commit
         with:
           python-version: ${{ inputs.python-version }}

.github/workflows/pre_merge.yml

@@ -23,6 +23,8 @@ jobs:
     steps:
       - name: CHECKOUT REPOSITORY
         uses: actions/checkout@v4
+        with:
+          lfs: true
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
@@ -53,7 +55,7 @@ jobs:
       - name: Link the dataset path to the dataset directory in the repository root.
         run: |
           ln -s $ANOMALIB_DATASET_PATH ./datasets
-          ln -s $ANOMALIB_DATASET_PATH ./notebooks/datasets
+          ln -s $ANOMALIB_DATASET_PATH ./examples/notebooks/datasets
       - name: Coverage
         run: tox -e pre-merge-${{ matrix.tox-env }}
       - name: Upload coverage report

.gitignore

@@ -8,8 +8,8 @@ results
 tmp*
 
 # Jupyter Notebooks
-notebooks/500_use_cases/501_dobot/
-!notebooks/500_use_cases/501_dobot/*.ipynb
+examples/notebooks/500_use_cases/501_dobot/
+!examples/notebooks/500_use_cases/501_dobot/*.ipynb
 
 # VENV
 .python-version