Skip to content

Commit 7008be2

Browse files
samet-akcaydjdameln
samet-akcay
and
djdameln
authored
📚Add how-to-guides and examples dir (#2475)
* update conf.py Signed-off-by: Samet Akcay <[email protected]> * Remove requirements.txt Signed-off-by: Samet Akcay <[email protected]> * Remove topic guide Signed-off-by: Samet Akcay <[email protected]> * Update conf.py Signed-off-by: Samet Akcay <[email protected]> * Add api guide landing page Signed-off-by: Samet Akcay <[email protected]> * Add data landing page Signed-off-by: Samet Akcay <[email protected]> * Add data documentation Signed-off-by: Samet Akcay <[email protected]> * Deleted files Signed-off-by: Samet Akcay <[email protected]> * Deleted files Signed-off-by: Samet Akcay <[email protected]> * Deleted files Signed-off-by: Samet Akcay <[email protected]> * Modified files Signed-off-by: Samet Akcay <[email protected]> * Modified files Signed-off-by: Samet Akcay <[email protected]> * Update callback docstrings Signed-off-by: Samet Akcay <[email protected]> * Update cli docstrings Signed-off-by: Samet Akcay <[email protected]> * Update callback docstrings Signed-off-by: Samet Akcay <[email protected]> * Update dataclasses and datamodules docstrings Signed-off-by: Samet Akcay <[email protected]> * Update datasets docstrings Signed-off-by: Samet Akcay <[email protected]> * Update utils docstrings Signed-off-by: Samet Akcay <[email protected]> * Update validators docstrings Signed-off-by: Samet Akcay <[email protected]> * Add the remaining docstrings Signed-off-by: Samet Akcay <[email protected]> * Add deploy docstrings Signed-off-by: Samet Akcay <[email protected]> * Add engine docstrings Signed-off-by: Samet Akcay <[email protected]> * Add logger docstrings Signed-off-by: Samet Akcay <[email protected]> * Add pimo docstrings Signed-off-by: Samet Akcay <[email protected]> * Add threshold docstrings Signed-off-by: Samet Akcay <[email protected]> * Add threshold docstrings Signed-off-by: Samet Akcay <[email protected]> * Add model components docstrings Signed-off-by: Samet Akcay <[email protected]> * add cfa Signed-off-by: Samet Akcay <[email protected]> * add cflow Signed-off-by: Samet Akcay <[email protected]> * add csflow Signed-off-by: Samet Akcay <[email protected]> * add dfm Signed-off-by: Samet Akcay <[email protected]> * add draem Signed-off-by: Samet Akcay <[email protected]> * add dsr Signed-off-by: Samet Akcay <[email protected]> * Add efficient-ad Signed-off-by: Samet Akcay <[email protected]> * add fastflow Signed-off-by: Samet Akcay <[email protected]> * add fre Signed-off-by: Samet Akcay <[email protected]> * add ganomaly Signed-off-by: Samet Akcay <[email protected]> * add patchcore Signed-off-by: Samet Akcay <[email protected]> * add reverse distillation Signed-off-by: Samet Akcay <[email protected]> * add stfpm Signed-off-by: Samet Akcay <[email protected]> * add uflow Signed-off-by: Samet Akcay <[email protected]> * add vlm-ad Signed-off-by: Samet Akcay <[email protected]> * add winclip Signed-off-by: Samet Akcay <[email protected]> * Add ai-vad Signed-off-by: Samet Akcay <[email protected]> * Add pipelines Signed-off-by: Samet Akcay <[email protected]> * Add pre and post processors Signed-off-by: Samet Akcay <[email protected]> * Add utils Signed-off-by: Samet Akcay <[email protected]> * Add visualizer Signed-off-by: Samet Akcay <[email protected]> * Update the licenses Signed-off-by: Samet Akcay <[email protected]> * Revert validators Signed-off-by: Samet Akcay <[email protected]> * Create examples directory Signed-off-by: Samet Akcay <[email protected]> * Create examples directory Signed-off-by: Samet Akcay <[email protected]> * Move notebooks to examples directory Signed-off-by: Samet Akcay <[email protected]> * Update links Signed-off-by: Samet Akcay <[email protected]> * Fix mypy issues Signed-off-by: Samet Akcay <[email protected]> * Move configs to examples Signed-off-by: Samet Akcay <[email protected]> * Update README.md file Signed-off-by: Samet Akcay <[email protected]> * Fix the notebook links Signed-off-by: Samet Akcay <[email protected]> * Fix incorrect docstrings Signed-off-by: Samet Akcay <[email protected]> * Fix incorrect docstrings Signed-off-by: Samet Akcay <[email protected]> * add missing 501 notebooks Signed-off-by: Samet Akcay <[email protected]> * Add how-to-guides Signed-off-by: Samet Akcay <[email protected]> * update dataclasses how-to-guides Signed-off-by: Samet Akcay <[email protected]> * update datasets how-to-guides Signed-off-by: Samet Akcay <[email protected]> * update datamodules how-to-guides Signed-off-by: Samet Akcay <[email protected]> * Disable old transforms how-to-guides Signed-off-by: Samet Akcay <[email protected]> * Add git lfs to tox ini Signed-off-by: Samet Akcay <[email protected]> * Set LFS to true when checking out the repo Signed-off-by: Samet Akcay <[email protected]> * Update post-processor how-to-guides Signed-off-by: Samet Akcay <[email protected]> * Add missing code. Misteriously disappeared Signed-off-by: Samet Akcay <[email protected]> * update dataclasses guide * update metrics and evaluator guide * Update docs/source/markdown/guides/how_to/evaluation/metrics.md Signed-off-by: Samet Akcay <[email protected]> * Update docs/source/markdown/guides/how_to/evaluation/metrics.md Signed-off-by: Samet Akcay <[email protected]> * Update docs/source/markdown/guides/how_to/evaluation/metrics.md Signed-off-by: Samet Akcay <[email protected]> * Update docs/source/markdown/guides/how_to/evaluation/metrics.md Signed-off-by: Samet Akcay <[email protected]> * update transforms guide * fix typo * add PreProcessor guide * update examples * Update the path to dataset in notebooks Signed-off-by: Samet Akcay <[email protected]> * update post-processor guide * update readme badges Signed-off-by: Samet Akcay <[email protected]> * Update API emoji Signed-off-by: Samet Akcay <[email protected]> * Add how-to-guide links to the release features Signed-off-by: Samet Akcay <[email protected]> * Update README.md Co-authored-by: Dick Ameln <[email protected]> --------- Signed-off-by: Samet Akcay <[email protected]> Co-authored-by: Dick Ameln <[email protected]> Co-authored-by: Dick Ameln <[email protected]>
1 parent 235952e commit 7008be2

File tree

131 files changed

+4116
-1152
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

131 files changed

+4116
-1152
lines changed

‎.gitattributes

+1-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
* text=auto eol=lf
33
*.{cmd,[cC][mM][dD]} text eol=crlf
44
*.{bat,[bB][aA][tT]} text eol=crlf
5-
65
# Ignore *ipynb files to detect the language.
76
# This is because GitHub misdetects the repo language when ipynb files are included.
8-
*.ipynb linguist-detectable=false
7+
*.ipynb filter=lfs diff=lfs merge=lfs -text

‎.github/CODEOWNERS

+6-6
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@
1515
/docs @samet-akcay
1616

1717
# Notebooks
18-
/notebooks/000_getting_started @samet-akcay
19-
/notebooks/100_datamodules @djdameln
20-
/notebooks/200_models @samet-akcay
21-
/notebooks/300_benchmarking @ashwinvaidya17
22-
/notebooks/400_openvino @samet-akcay
23-
/notebooks/README.md @samet-akcay
18+
/examples/notebooks/000_getting_started @samet-akcay
19+
/examples/notebooks/100_datamodules @djdameln
20+
/examples/notebooks/200_models @samet-akcay
21+
/examples/notebooks/300_benchmarking @ashwinvaidya17
22+
/examples/notebooks/400_openvino @samet-akcay
23+
/examples/notebooks/README.md @samet-akcay
2424

2525
# Requirements
2626
/requirements/ @samet-akcay @ashwinvaidya17 @djdameln

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

+1
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ jobs:
6262
- uses: actions/checkout@v4
6363
with:
6464
fetch-depth: 0
65+
lfs: true
6566
- uses: ./.github/actions/code-quality/pre-commit
6667
with:
6768
python-version: ${{ inputs.python-version }}

‎.github/workflows/pre_merge.yml

+3-1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ jobs:
2323
steps:
2424
- name: CHECKOUT REPOSITORY
2525
uses: actions/checkout@v4
26+
with:
27+
lfs: true
2628
- name: Set up Python
2729
uses: actions/setup-python@v5
2830
with:
@@ -53,7 +55,7 @@ jobs:
5355
- name: Link the dataset path to the dataset directory in the repository root.
5456
run: |
5557
ln -s $ANOMALIB_DATASET_PATH ./datasets
56-
ln -s $ANOMALIB_DATASET_PATH ./notebooks/datasets
58+
ln -s $ANOMALIB_DATASET_PATH ./examples/notebooks/datasets
5759
- name: Coverage
5860
run: tox -e pre-merge-${{ matrix.tox-env }}
5961
- name: Upload coverage report

‎.gitignore

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ results
88
tmp*
99

1010
# Jupyter Notebooks
11-
notebooks/500_use_cases/501_dobot/
12-
!notebooks/500_use_cases/501_dobot/*.ipynb
11+
examples/notebooks/500_use_cases/501_dobot/
12+
!examples/notebooks/500_use_cases/501_dobot/*.ipynb
1313

1414
# VENV
1515
.python-version

0 commit comments

Comments
 (0)