From 38725ad35e753510432d4b7c9d65259d67e97747 Mon Sep 17 00:00:00 2001 From: Samet Akcay Date: Fri, 18 Feb 2022 09:55:58 +0000 Subject: [PATCH] Add Citation to the Readme (#106) * Added citation * added citation to docs * added paper to citation.cff * fix version * remove family name from givenname * renamed the name of the library * revert the title --- CITATION.cff | 92 ++++++++++++++++++++++++++++++++ README.md | 50 +++++++++++------ docs/source/research/citation.md | 14 ++++- 3 files changed, 139 insertions(+), 17 deletions(-) create mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000000..65e69ee039 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,92 @@ +# This CITATION.cff file was generated with cffinit. +# Visit https://bit.ly/cffinit to generate yours today! + +cff-version: 1.2.0 +title: "Anomalib: A Deep Learning Library for Anomaly Detection" +message: "If you use this library and love it, cite the software and the paper \U0001F917" +authors: + - given-names: Samet + family-names: Akcay + email: samet.akcay@intel.com + affiliation: Intel + - given-names: Dick + family-names: Ameln + email: dick.ameln@intel.com + affiliation: Intel + - given-names: Ashwin + family-names: Vaidya + email: ashwin.vaidya@intel.com + affiliation: Intel + - given-names: Barath + family-names: Lakshmanan + email: barath.lakshmanan@intel.com + affiliation: Intel + - given-names: Nilesh + family-names: Ahuja + email: nilesh.ahuja@intel.com + affiliation: Intel + - given-names: Utku + family-names: Genc + email: utku.genc@intel.com + affiliation: Intel +version: 0.2.4 +doi: https://doi.org/10.48550/arXiv.2202.08341 +date-released: 2022-02-18 +references: + - type: article + authors: + - given-names: Samet + family-names: Akcay + email: samet.akcay@intel.com + affiliation: Intel + - given-names: Dick + family-names: Ameln + email: dick.ameln@intel.com + affiliation: Intel + - given-names: Ashwin + family-names: Vaidya + email: ashwin.vaidya@intel.com + affiliation: Intel + - given-names: Barath + family-names: Lakshmanan + email: barath.lakshmanan@intel.com + affiliation: Intel + - given-names: Nilesh + family-names: Ahuja + email: nilesh.ahuja@intel.com + affiliation: Intel + - given-names: Utku + family-names: Genc + email: utku.genc@intel.com + affiliation: Intel + title: "Anomalib: A Deep Learning Library for Anomaly Detection" + year: 2022 + journal: ArXiv + doi: https://doi.org/10.48550/arXiv.2202.08341 + url: https://arxiv.org/abs/2202.08341 + +abstract: >- + This paper introduces anomalib, a novel library for + unsupervised anomaly detection and localization. + With reproducibility and modularity in mind, this + open-source library provides algorithms from the + literature and a set of tools to design custom + anomaly detection algorithms via a plug-and-play + approach. Anomalib comprises state-of-the-art + anomaly detection algorithms that achieve top + performance on the benchmarks and that can be used + off-the-shelf. In addition, the library provides + components to design custom algorithms that could + be tailored towards specific needs. Additional + tools, including experiment trackers, visualizers, + and hyper-parameter optimizers, make it simple to + design and implement anomaly detection models. The + library also supports OpenVINO model optimization + and quantization for real-time deployment. Overall, + anomalib is an extensive library for the design, + implementation, and deployment of unsupervised + anomaly detection models from data to the edge. +keywords: + - Unsupervised Anomaly detection + - Unsupervised Anomaly localization +license: Apache-2.0 diff --git a/README.md b/README.md index d02f6837a6..762c2b8673 100644 --- a/README.md +++ b/README.md @@ -157,8 +157,8 @@ ___ | Model | | Avg | Carpet | Grid | Leather | Tile | Wood | Bottle | Cable | Capsule | Hazelnut | Metal Nut | Pill | Screw | Toothbrush | Transistor | Zipper | | ------------- | ------------------ | :-------: | :-------: | :-------: | :-----: | :-------: | :-------: | :-----: | :-------: | :-------: | :------: | :-------: | :-------: | :-------: | :--------: | :--------: | :-------: | -| **PatchCore** | **Wide ResNet-50** | **0.980** | 0.984 | 0.959 | 1.000 | **1.000** | 0.989 | 1.000 | **0.990** | **0.982** | 1.000 | 0.994 | 0.924 | 0.960 | 0.933 | **1.000** | 0.982 | -| PatchCore | ResNet-18 | 0.973 | 0.970 | 0.947 | 1.000 | 0.997 | 0.997 | 1.000 | 0.986 | 0.965 | 1.000 | 0.991 | 0.916 | **0.943** | 0.931 | 0.996 | 0.953 | +| **PatchCore** | **Wide ResNet-50** | **0.980** | 0.984 | 0.959 | 1.000 | **1.000** | 0.989 | 1.000 | **0.990** | **0.982** | 1.000 | 0.994 | 0.924 | 0.960 | 0.933 | **1.000** | 0.982 | +| PatchCore | ResNet-18 | 0.973 | 0.970 | 0.947 | 1.000 | 0.997 | 0.997 | 1.000 | 0.986 | 0.965 | 1.000 | 0.991 | 0.916 | **0.943** | 0.931 | 0.996 | 0.953 | | CFlow | Wide ResNet-50 | 0.962 | 0.986 | 0.962 | **1.0** | 0.999 | **0.993** | **1.0** | 0.893 | 0.945 | **1.0** | **0.995** | 0.924 | 0.908 | 0.897 | 0.943 | **0.984** | | PaDiM | Wide ResNet-50 | 0.950 | **0.995** | 0.942 | 1.0 | 0.974 | **0.993** | 0.999 | 0.878 | 0.927 | 0.964 | 0.989 | **0.939** | 0.845 | 0.942 | 0.976 | 0.882 | | PaDiM | ResNet-18 | 0.891 | 0.945 | 0.857 | 0.982 | 0.950 | 0.976 | 0.994 | 0.844 | 0.901 | 0.750 | 0.961 | 0.863 | 0.759 | 0.889 | 0.920 | 0.780 | @@ -174,7 +174,7 @@ ___ | Model | | Avg | Carpet | Grid | Leather | Tile | Wood | Bottle | Cable | Capsule | Hazelnut | Metal Nut | Pill | Screw | Toothbrush | Transistor | Zipper | | ------------- | ------------------ | :-------: | :-------: | :-------: | :-------: | :-------: | :-------: | :-------: | :-------: | :-------: | :-------: | :-------: | :-------: | :-------: | :--------: | :--------: | :-------: | | **PatchCore** | **Wide ResNet-50** | **0.980** | 0.988 | 0.968 | 0.991 | 0.961 | 0.934 | 0.984 | **0.988** | **0.988** | 0.987 | **0.989** | 0.980 | **0.989** | 0.988 | **0.981** | 0.983 | -| PatchCore | ResNet-18 | 0.976 | 0.986 | 0.955 | 0.990 | 0.943 | 0.933 | 0.981 | 0.984 | 0.986 | 0.986 | 0.986 | 0.974 | 0.991 | 0.988 | 0.974 | 0.983 | +| PatchCore | ResNet-18 | 0.976 | 0.986 | 0.955 | 0.990 | 0.943 | 0.933 | 0.981 | 0.984 | 0.986 | 0.986 | 0.986 | 0.974 | 0.991 | 0.988 | 0.974 | 0.983 | | CFlow | Wide ResNet-50 | 0.971 | 0.986 | 0.968 | 0.993 | **0.968** | 0.924 | 0.981 | 0.955 | **0.988** | **0.990** | 0.982 | **0.983** | 0.979 | 0.985 | 0.897 | 0.980 | | PaDiM | Wide ResNet-50 | 0.979 | **0.991** | 0.970 | 0.993 | 0.955 | **0.957** | **0.985** | 0.970 | **0.988** | 0.985 | 0.982 | 0.966 | 0.988 | **0.991** | 0.976 | **0.986** | | PaDiM | ResNet-18 | 0.968 | 0.984 | 0.918 | **0.994** | 0.934 | 0.947 | 0.983 | 0.965 | 0.984 | 0.978 | 0.970 | 0.957 | 0.978 | 0.988 | 0.968 | 0.979 | @@ -183,16 +183,34 @@ ___ ### Image F1 Score -| Model | | Avg | Carpet | Grid | Leather | Tile | Wood | Bottle | Cable | Capsule | Hazelnut | Metal Nut | Pill | Screw | Toothbrush | Transistor | Zipper | -| ------------- | ------------------ | :-------: | :-------: | :-------: | :-----: | :-------: | :-------: | :-----: | :-------: | :-------: | :------: | :-------: | :-------: | :--------: | :--------: | :--------: | :-------: | -| **PatchCore** | **Wide ResNet-50** | **0.976** | 0.971 | 0.974 |**1.000**| **1.000** | 0.967 |**1.000**| 0.968 | **0.982** |**1.000** | 0.984 | 0.940 | 0.943 | 0.938 | **1.000** | **0.979** | -| PatchCore | ResNet-18 | 0.970 | 0.949 | 0.946 |**1.000**| 0.98 | **0.992** |**1.000**| **0.978** | 0.969 |**1.000** | **0.989** | 0.940 | 0.932 | 0.935 | 0.974 | 0.967 | -| CFlow | Wide ResNet-50 | 0.944 | 0.972 | 0.932 | **1.0** | 0.988 | 0.967 | **1.0** | 0.832 | 0.939 | **1.0** | 0.979 | 0.924 | **0.971** | 0.870 | 0.818 | 0.967 | -| PaDiM | Wide ResNet-50 | 0.951 | **0.989** | 0.930 | **1.0** | 0.960 | 0.983 | 0.992 | 0.856 | **0.982** | 0.937 | 0.978 | **0.946** | 0.895 | 0.952 | 0.914 | 0.947 | -| PaDiM | ResNet-18 | 0.916 | 0.930 | 0.893 | 0.984 | 0.934 | 0.952 | 0.976 | 0.858 | 0.960 | 0.836 | 0.974 | 0.932 | 0.879 | 0.923 | 0.796 | 0.915 | -| STFPM | Wide ResNet-50 | 0.926 | 0.973 | 0.973 | 0.974 | 0.965 | 0.929 | 0.976 | 0.853 | 0.920 | 0.972 | 0.974 | 0.922 | 0.884 | 0.833 | 0.815 | 0.931 | -| STFPM | ResNet-18 | 0.932 | 0.961 | **0.982** | 0.989 | 0.930 | 0.951 | 0.984 | 0.819 | 0.918 | 0.993 | 0.973 | 0.918 | 0.887 | **0.984** | 0.790 | 0.908 | -| DFM | Wide ResNet-50 | 0.918 | 0.960 | 0.844 | 0.990 | 0.970 | 0.959 | 0.976 | 0.848 | 0.944 | 0.913 | 0.912 | 0.919 | 0.859 | 0.893 | 0.815 | 0.961 | -| DFM | ResNet-18 | 0.919 | 0.895 | 0.844 | 0.926 | 0.971 | 0.948 | 0.977 | 0.874 | 0.935 | 0.957 | 0.958 | 0.921 | 0.874 | 0.933 | 0.833 | 0.943 | -| DFKDE | Wide ResNet-50 | 0.875 | 0.907 | 0.844 | 0.905 | 0.945 | 0.914 | 0.946 | 0.790 | 0.914 | 0.817 | 0.894 | 0.922 | 0.855 | 0.845 | 0.722 | 0.910 | -| DFKDE | ResNet-18 | 0.872 | 0.864 | 0.844 | 0.854 | 0.960 | 0.898 | 0.942 | 0.793 | 0.908 | 0.827 | 0.894 | 0.916 | 0.859 | 0.853 | 0.756 | 0.916 | +| Model | | Avg | Carpet | Grid | Leather | Tile | Wood | Bottle | Cable | Capsule | Hazelnut | Metal Nut | Pill | Screw | Toothbrush | Transistor | Zipper | +| ------------- | ------------------ | :-------: | :-------: | :-------: | :-------: | :-------: | :-------: | :-------: | :-------: | :-------: | :-------: | :-------: | :-------: | :-------: | :--------: | :--------: | :-------: | +| **PatchCore** | **Wide ResNet-50** | **0.976** | 0.971 | 0.974 | **1.000** | **1.000** | 0.967 | **1.000** | 0.968 | **0.982** | **1.000** | 0.984 | 0.940 | 0.943 | 0.938 | **1.000** | **0.979** | +| PatchCore | ResNet-18 | 0.970 | 0.949 | 0.946 | **1.000** | 0.98 | **0.992** | **1.000** | **0.978** | 0.969 | **1.000** | **0.989** | 0.940 | 0.932 | 0.935 | 0.974 | 0.967 | +| CFlow | Wide ResNet-50 | 0.944 | 0.972 | 0.932 | **1.0** | 0.988 | 0.967 | **1.0** | 0.832 | 0.939 | **1.0** | 0.979 | 0.924 | **0.971** | 0.870 | 0.818 | 0.967 | +| PaDiM | Wide ResNet-50 | 0.951 | **0.989** | 0.930 | **1.0** | 0.960 | 0.983 | 0.992 | 0.856 | **0.982** | 0.937 | 0.978 | **0.946** | 0.895 | 0.952 | 0.914 | 0.947 | +| PaDiM | ResNet-18 | 0.916 | 0.930 | 0.893 | 0.984 | 0.934 | 0.952 | 0.976 | 0.858 | 0.960 | 0.836 | 0.974 | 0.932 | 0.879 | 0.923 | 0.796 | 0.915 | +| STFPM | Wide ResNet-50 | 0.926 | 0.973 | 0.973 | 0.974 | 0.965 | 0.929 | 0.976 | 0.853 | 0.920 | 0.972 | 0.974 | 0.922 | 0.884 | 0.833 | 0.815 | 0.931 | +| STFPM | ResNet-18 | 0.932 | 0.961 | **0.982** | 0.989 | 0.930 | 0.951 | 0.984 | 0.819 | 0.918 | 0.993 | 0.973 | 0.918 | 0.887 | **0.984** | 0.790 | 0.908 | +| DFM | Wide ResNet-50 | 0.918 | 0.960 | 0.844 | 0.990 | 0.970 | 0.959 | 0.976 | 0.848 | 0.944 | 0.913 | 0.912 | 0.919 | 0.859 | 0.893 | 0.815 | 0.961 | +| DFM | ResNet-18 | 0.919 | 0.895 | 0.844 | 0.926 | 0.971 | 0.948 | 0.977 | 0.874 | 0.935 | 0.957 | 0.958 | 0.921 | 0.874 | 0.933 | 0.833 | 0.943 | +| DFKDE | Wide ResNet-50 | 0.875 | 0.907 | 0.844 | 0.905 | 0.945 | 0.914 | 0.946 | 0.790 | 0.914 | 0.817 | 0.894 | 0.922 | 0.855 | 0.845 | 0.722 | 0.910 | +| DFKDE | ResNet-18 | 0.872 | 0.864 | 0.844 | 0.854 | 0.960 | 0.898 | 0.942 | 0.793 | 0.908 | 0.827 | 0.894 | 0.916 | 0.859 | 0.853 | 0.756 | 0.916 | + +## Reference +If you use this library and love it, use this to cite it 🤗 +``` +@misc{anomalib, + title={Anomalib: A Deep Learning Library for Anomaly Detection}, + author={Samet Akcay and + Dick Ameln and + Ashwin Vaidya and + Barath Lakshmanan and + Nilesh Ahuja and + Utku Genc}, + year={2022}, + eprint={2202.08341}, + archivePrefix={arXiv}, + primaryClass={cs.CV} +} +``` diff --git a/docs/source/research/citation.md b/docs/source/research/citation.md index aa18f0e000..2485b53bdc 100644 --- a/docs/source/research/citation.md +++ b/docs/source/research/citation.md @@ -3,5 +3,17 @@ You can cite this repository as ``` -TODO +@misc{anomalib, + title={Anomalib: A Deep Learning Library for Anomaly Detection}, + author={Samet Akcay and + Dick Ameln and + Ashwin Vaidya and + Barath Lakshmanan and + Nilesh Ahuja and + Utku Genc}, + year={2022}, + eprint={2202.08341}, + archivePrefix={arXiv}, + primaryClass={cs.CV} +} ```