Skip to content

Commit

Permalink
Release 0.5.0 (#1081)
Browse files Browse the repository at this point in the history
* Fix metadata path

* Release v0.5.0

* update the documentation

* Add AIVAD to Changelog
  • Loading branch information
samet-akcay committed May 9, 2023
1 parent 1bd70af commit f27e533
Show file tree
Hide file tree
Showing 4 changed files with 58 additions and 7 deletions.
1 change: 1 addition & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ jobs:
uses: actions/checkout@v2
- name: Install requirements
run: |
pip install -r requirements/docs.txt
pip install .[full]
- name: Link dataset path to local directory as nbsphinx runs the notebook
run: ln -s $ANOMALIB_DATASET_PATH ./datasets
Expand Down
56 changes: 55 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,74 @@ All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## [Unreleased]
## [v0.5.0] - 2023-05-09

### Added

- 📚 Add OpenVINO Inference to getting started notebook. by @samet-akcay in https://github.com/openvinotoolkit/anomalib/pull/897
- Mvtec 3d by @alexriedel1 in https://github.com/openvinotoolkit/anomalib/pull/907
- MVTec 3D and Folder3D by @alexriedel1 in https://github.com/openvinotoolkit/anomalib/pull/942
- add reorder=True argument in aupro by @triet1102 in https://github.com/openvinotoolkit/anomalib/pull/944
- always reorder inputs when computing AUROC by @djdameln in https://github.com/openvinotoolkit/anomalib/pull/945
- always reorder for aupr metric by @triet1102 in https://github.com/openvinotoolkit/anomalib/pull/975
- Add `README.md` files to `notebooks` directories and its subdirectories (<https://github.com/openvinotoolkit/anomalib/issues/993>)
- Set transformations from the config file by @alexriedel1 in https://github.com/openvinotoolkit/anomalib/pull/990
- Add contributors to `README.md` by @samet-akcay in https://github.com/openvinotoolkit/anomalib/pull/995
- Add codeowners file by @samet-akcay in https://github.com/openvinotoolkit/anomalib/pull/1019
- Configure reference frame for multi-frame video clips by @djdameln in https://github.com/openvinotoolkit/anomalib/pull/1023
- [Algo] Attribute-based Representations for Accurate and Interpretable Video Anomaly Detection by @djdameln in https://github.com/openvinotoolkit/anomalib/pull/1040

### Changed

- Switch to src layout by @samet-akcay in https://github.com/openvinotoolkit/anomalib/pull/921
- Remove `config` flag from `OpenVINOInferencer` (<https://github.com/openvinotoolkit/anomalib/pull/939>)
- Add ruff as the main linter by @samet-akcay in https://github.com/openvinotoolkit/anomalib/pull/936
- Add a new workflow for code scanning by @yunchu in https://github.com/openvinotoolkit/anomalib/pull/940
- Enable bandit scanning by @yunchu in https://github.com/openvinotoolkit/anomalib/pull/954
- 🐳 Update Containers and Readme by @ashwinvaidya17 in https://github.com/openvinotoolkit/anomalib/pull/952
- Refactor AUPRO metric by @triet1102 in https://github.com/openvinotoolkit/anomalib/pull/991
- enable auto-fixing for ruff in pre-commit by @djdameln in https://github.com/openvinotoolkit/anomalib/pull/1004
- Refactor strings and ints into enum.Enum by @WenjingKangIntel in https://github.com/openvinotoolkit/anomalib/pull/1044
- Modify codecov upload by @ashwinvaidya17 in https://github.com/openvinotoolkit/anomalib/pull/1080

### Deprecated

- Remove torchvision and torchtext by @samet-akcay in https://github.com/openvinotoolkit/anomalib/pull/903
- Remove codacy from ci docs by @ashwinvaidya17 in https://github.com/openvinotoolkit/anomalib/pull/924
- Remove config dependency from `OpenVINOInferencer` by @samet-akcay in https://github.com/openvinotoolkit/anomalib/pull/939
- Remove config from torch inferencer by @samet-akcay in https://github.com/openvinotoolkit/anomalib/pull/1001

###  Fixed

- Bugfix code logic to allow for passing of `nn.Module` to `TorchFXFeatureExtractor` by @ORippler in https://github.com/openvinotoolkit/anomalib/pull/935
- fix broken links to tutorials (ex guides) by @sergiev in https://github.com/openvinotoolkit/anomalib/pull/957
- Fixed outdated info in readme by @blaz-r in https://github.com/openvinotoolkit/anomalib/pull/969
- Fix ruff isort integration by @samet-akcay in https://github.com/openvinotoolkit/anomalib/pull/976
- Fix/samples dataframe annotation by @samet-akcay in https://github.com/openvinotoolkit/anomalib/pull/981
- Fixed openvino_inferencer in gradio_inference by @blaz-r in https://github.com/openvinotoolkit/anomalib/pull/972
- Fix issue in tutorial by @Ravindu987 in https://github.com/openvinotoolkit/anomalib/pull/997
- Fix tarfile vulnerability by @djdameln in https://github.com/openvinotoolkit/anomalib/pull/1003
- Cuda 11.4 dockerfile fix by @phcarval in https://github.com/openvinotoolkit/anomalib/pull/1021
- Make anomalib PEP 561 compliant for mypy by @WenjingKangIntel in https://github.com/openvinotoolkit/anomalib/pull/1038
- [Bug: 839] Crop in SSPCAB implementation by @isaacncz in https://github.com/openvinotoolkit/anomalib/pull/1057
- [Bug: 865] datamodule.setup() assertion failed by @isaacncz in https://github.com/openvinotoolkit/anomalib/pull/1058
- Fix logger message for test_split_ratio by @ugotsoul in https://github.com/openvinotoolkit/anomalib/pull/1071
- Fix notebook readme formatting by @samet-akcay in https://github.com/openvinotoolkit/anomalib/pull/1075

### New Contributors

- @triet1102 made their first contribution in https://github.com/openvinotoolkit/anomalib/pull/944
- @sergiev made their first contribution in https://github.com/openvinotoolkit/anomalib/pull/957
- @blaz-r made their first contribution in https://github.com/openvinotoolkit/anomalib/pull/969
- @ineiti made their first contribution in https://github.com/openvinotoolkit/anomalib/pull/987
- @Ravindu987 made their first contribution in https://github.com/openvinotoolkit/anomalib/pull/997
- @phcarval made their first contribution in https://github.com/openvinotoolkit/anomalib/pull/1021
- @WenjingKangIntel made their first contribution in https://github.com/openvinotoolkit/anomalib/pull/1038
- @isaacncz made their first contribution in https://github.com/openvinotoolkit/anomalib/pull/1057
- @ugotsoul made their first contribution in https://github.com/openvinotoolkit/anomalib/pull/1071

**Full Changelog**: https://github.com/openvinotoolkit/anomalib/compare/v0.4.0...v0.5.0

## [v0.4.0] - 2023-03-01

### Added
Expand Down
6 changes: 1 addition & 5 deletions docs/source/tutorials/inference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ To run OpenVINO inference, first make sure that your model has been exported to
+-----------+----------+--------------------------------------------------------------------------------------+
| Parameter | Required | Description |
+===========+==========+======================================================================================+
| config | True | Path to the model config file. |
+-----------+----------+--------------------------------------------------------------------------------------+
| weights | True | Path to the OpenVINO IR model file (either ``.xml`` or ``.bin``) |
+-----------+----------+--------------------------------------------------------------------------------------+
Expand All @@ -62,7 +61,7 @@ For correct inference results, the ``metadata`` argument should be specified and

As an example, OpenVINO inference can be triggered by the following command:

``python tools/inference/openvino.py --config padim.yaml --weights results/openvino/model.xml --input image.png --metadata results/openvino/metadata.json``
``python tools/inference/openvino.py --weights results/openvino/model.xml --input image.png --metadata results/openvino/metadata.json``

Similar to PyTorch inference, the visualization results will be displayed on the screen, and optionally saved to the file system location specified by the ``save_data`` parameter.

Expand All @@ -76,7 +75,6 @@ The gradio inference is supported for both PyTorch and OpenVINO models.
+-----------+----------+------------------------------------------------------------------+
| Parameter | Required | Description |
+===========+==========+==================================================================+
| config | True | Path to the model config file. |
+-----------+----------+------------------------------------------------------------------+
| weights | True | Path to the OpenVINO IR model file (either ``.xml`` or ``.bin``) |
+-----------+----------+------------------------------------------------------------------+
Expand All @@ -95,14 +93,12 @@ As an example, PyTorch model can be used by the following command:
.. code-block:: bash
python tools/inference/gradio_inference.py \
--config ./anomalib/models/padim/config.yaml \
--weights ./results/padim/mvtec/bottle/weights/model.ckpt
Similarly, you can use OpenVINO model by the following command:

.. code-block:: bash
python python tools/inference/gradio_inference.py \
--config ./anomalib/models/padim/config.yaml \
--weights ./results/padim/mvtec/bottle/openvino/openvino_model.onnx \
--metadata ./results/padim/mvtec/bottle/openvino/metadata.json
2 changes: 1 addition & 1 deletion src/anomalib/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
# Copyright (C) 2022 Intel Corporation
# SPDX-License-Identifier: Apache-2.0

__version__ = "0.5.0-dev"
__version__ = "0.5.0"

0 comments on commit f27e533

Please sign in to comment.