oodeel 0.1.1__tar.gz → 0.3.0__tar.gz

{oodeel-0.1.1/oodeel.egg-info → oodeel-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: oodeel
-Version: 0.1.1
+Version: 0.3.0
 Summary: Simple, compact, and hackable post-hoc deep OOD detection for alreadytrained tensorflow or pytorch image classifiers.
 Author: DEEL Core Team
 Author-email: paul.novello@irt-saintexupery.com
@@ -11,13 +11,127 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: faiss_cpu
+Requires-Dist: numpy
+Requires-Dist: scikit_learn
+Requires-Dist: scipy
+Requires-Dist: setuptools
+Requires-Dist: matplotlib
+Requires-Dist: pandas
+Requires-Dist: seaborn
+Requires-Dist: plotly
+Requires-Dist: tqdm
 Provides-Extra: dev
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: ipywidgets; extra == "dev"
+Requires-Dist: mkdocs-jupyter; extra == "dev"
+Requires-Dist: mkdocstrings-python; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: setuptools; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: tox; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: ipython; extra == "dev"
+Requires-Dist: ipykernel; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: mkdocs; extra == "dev"
+Requires-Dist: mkdocs-material; extra == "dev"
+Requires-Dist: mkdocstrings; extra == "dev"
+Requires-Dist: mknotebooks; extra == "dev"
+Requires-Dist: mike; extra == "dev"
+Requires-Dist: bump2version; extra == "dev"
+Requires-Dist: docsig; extra == "dev"
+Requires-Dist: no_implicit_optional; extra == "dev"
+Requires-Dist: numpy==1.26.4; extra == "dev"
+Requires-Dist: tensorflow==2.11.0; extra == "dev"
+Requires-Dist: tensorflow_datasets; extra == "dev"
+Requires-Dist: tensorflow_probability==0.19.0; extra == "dev"
+Requires-Dist: timm; extra == "dev"
+Requires-Dist: torch==1.13.1; extra == "dev"
+Requires-Dist: torchvision==0.14.1; extra == "dev"
 Provides-Extra: tensorflow-dev
+Requires-Dist: mypy; extra == "tensorflow-dev"
+Requires-Dist: ipywidgets; extra == "tensorflow-dev"
+Requires-Dist: mkdocs-jupyter; extra == "tensorflow-dev"
+Requires-Dist: mkdocstrings-python; extra == "tensorflow-dev"
+Requires-Dist: flake8; extra == "tensorflow-dev"
+Requires-Dist: setuptools; extra == "tensorflow-dev"
+Requires-Dist: pre-commit; extra == "tensorflow-dev"
+Requires-Dist: tox; extra == "tensorflow-dev"
+Requires-Dist: black; extra == "tensorflow-dev"
+Requires-Dist: ruff; extra == "tensorflow-dev"
+Requires-Dist: ipython; extra == "tensorflow-dev"
+Requires-Dist: ipykernel; extra == "tensorflow-dev"
+Requires-Dist: pytest; extra == "tensorflow-dev"
+Requires-Dist: pylint; extra == "tensorflow-dev"
+Requires-Dist: mypy; extra == "tensorflow-dev"
+Requires-Dist: mkdocs; extra == "tensorflow-dev"
+Requires-Dist: mkdocs-material; extra == "tensorflow-dev"
+Requires-Dist: mkdocstrings; extra == "tensorflow-dev"
+Requires-Dist: mknotebooks; extra == "tensorflow-dev"
+Requires-Dist: mike; extra == "tensorflow-dev"
+Requires-Dist: bump2version; extra == "tensorflow-dev"
+Requires-Dist: docsig; extra == "tensorflow-dev"
+Requires-Dist: no_implicit_optional; extra == "tensorflow-dev"
+Requires-Dist: numpy==1.26.4; extra == "tensorflow-dev"
+Requires-Dist: tensorflow==2.11.0; extra == "tensorflow-dev"
+Requires-Dist: tensorflow_datasets; extra == "tensorflow-dev"
+Requires-Dist: tensorflow_probability==0.19.0; extra == "tensorflow-dev"
 Provides-Extra: torch-dev
+Requires-Dist: mypy; extra == "torch-dev"
+Requires-Dist: ipywidgets; extra == "torch-dev"
+Requires-Dist: mkdocs-jupyter; extra == "torch-dev"
+Requires-Dist: mkdocstrings-python; extra == "torch-dev"
+Requires-Dist: flake8; extra == "torch-dev"
+Requires-Dist: setuptools; extra == "torch-dev"
+Requires-Dist: pre-commit; extra == "torch-dev"
+Requires-Dist: tox; extra == "torch-dev"
+Requires-Dist: black; extra == "torch-dev"
+Requires-Dist: ruff; extra == "torch-dev"
+Requires-Dist: ipython; extra == "torch-dev"
+Requires-Dist: ipykernel; extra == "torch-dev"
+Requires-Dist: pytest; extra == "torch-dev"
+Requires-Dist: pylint; extra == "torch-dev"
+Requires-Dist: mypy; extra == "torch-dev"
+Requires-Dist: mkdocs; extra == "torch-dev"
+Requires-Dist: mkdocs-material; extra == "torch-dev"
+Requires-Dist: mkdocstrings; extra == "torch-dev"
+Requires-Dist: mknotebooks; extra == "torch-dev"
+Requires-Dist: mike; extra == "torch-dev"
+Requires-Dist: bump2version; extra == "torch-dev"
+Requires-Dist: docsig; extra == "torch-dev"
+Requires-Dist: no_implicit_optional; extra == "torch-dev"
+Requires-Dist: numpy==1.26.4; extra == "torch-dev"
+Requires-Dist: timm; extra == "torch-dev"
+Requires-Dist: torch==1.13.1; extra == "torch-dev"
+Requires-Dist: torchvision==0.14.1; extra == "torch-dev"
 Provides-Extra: tensorflow
+Requires-Dist: tensorflow==2.11.0; extra == "tensorflow"
+Requires-Dist: tensorflow_datasets; extra == "tensorflow"
+Requires-Dist: tensorflow_probability==0.19.0; extra == "tensorflow"
 Provides-Extra: torch
+Requires-Dist: timm; extra == "torch"
+Requires-Dist: torch==1.13.1; extra == "torch"
+Requires-Dist: torchvision==0.14.1; extra == "torch"
 Provides-Extra: docs
-License-File: LICENSE
+Requires-Dist: mkdocs; extra == "docs"
+Requires-Dist: mkdocs-material; extra == "docs"
+Requires-Dist: mkdocstrings; extra == "docs"
+Requires-Dist: mknotebooks; extra == "docs"
+Requires-Dist: ipython; extra == "docs"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
 
 
 <!-- Banner section -->
@@ -33,29 +147,23 @@ License-File: LICENSE
 <!-- Badge section -->
 <div align="center">
     <a href="#">
-        <img src="https://img.shields.io/badge/python-3.8%2B-blue">
-    </a>
+        <img src="https://img.shields.io/badge/python-3.8%2B-blue"></a>
     <a href="https://github.com/deel-ai/oodeel/actions/workflows/python-linters.yml">
-        <img alt="Flake8" src="https://github.com/deel-ai/oodeel/actions/workflows/python-linters.yml/badge.svg">
-    </a>
+        <img alt="Flake8" src="https://github.com/deel-ai/oodeel/actions/workflows/python-linters.yml/badge.svg"></a>
     <a href="https://github.com/deel-ai/oodeel/actions/workflows/python-tests-tf.yml">
-        <img alt="Tests tf" src="https://github.com/deel-ai/oodeel/actions/workflows/python-tests-tf.yml/badge.svg">
-    </a>
+        <img alt="Tests tf" src="https://github.com/deel-ai/oodeel/actions/workflows/python-tests-tf.yml/badge.svg"></a>
     <a href="https://github.com/deel-ai/oodeel/actions/workflows/python-tests-torch.yml">
-        <img alt="Tests torch" src="https://github.com/deel-ai/oodeel/actions/workflows/python-tests-torch.yml/badge.svg">
-    </a>
+        <img alt="Tests torch" src="https://github.com/deel-ai/oodeel/actions/workflows/python-tests-torch.yml/badge.svg"></a>
     <a href="https://github.com/deel-ai/oodeel/actions/workflows/python-coverage-shield.yml">
-        <img alt="Coverage" src="https://github.com/deel-ai/oodeel/raw/gh-shields/coverage.svg">
-    </a>
+        <img alt="Coverage" src="https://github.com/deel-ai/oodeel/raw/gh-shields/coverage.svg"></a>
     <a href="https://github.com/deel-ai/oodeel/blob/master/LICENSE">
-        <img alt="License MIT" src="https://img.shields.io/badge/License-MIT-efefef">
-    </a>
+        <img alt="License MIT" src="https://img.shields.io/badge/License-MIT-efefef"></a>
 </div>
 <br>
 
 <!-- Short description of your library -->
 
-<b>Oodeel</b> is a library that performs post-hoc deep OOD detection on already trained neural network image classifiers. The philosophy of the library is to favor quality over quantity and to foster easy adoption. As a result, we provide a simple, compact and easily customizable API and carefully integrate and test each proposed baseline into a coherent framework that is designed to enable their use in tensorflow **and** pytorch. You can find the documentation [here](https://deel-ai.github.io/oodeel/).
+<b>Oodeel</b> is a library that performs post-hoc deep OOD (Out-of-Distribution) detection on already trained neural network image classifiers. The philosophy of the library is to favor quality over quantity and to foster easy adoption. As a result, we provide a simple, compact and easily customizable API and carefully integrate and test each proposed baseline into a coherent framework that is designed to enable their use in tensorflow **and** pytorch. You can find the documentation [here](https://deel-ai.github.io/oodeel/).
 
 ```python
 from oodeel.methods import MLS
@@ -75,7 +183,8 @@ scores, info = mls.score(ds) # ds is a tf.data.Dataset or a torch.DataLoader
 - [Contributing](#contributing)
 - [See Also](#see-also)
 - [Acknowledgments](#acknowledgments)
-- [Creator](#creator)
+- [Creators](#creators)
+- [Citation](#citation)
 - [License](#license)
 
 # Installation
@@ -194,15 +303,19 @@ Currently, **oodeel** includes the following baselines:
 | MSP | [A Baseline for Detecting Misclassified and Out-of-Distribution Examples in Neural Networks](http://arxiv.org/abs/1610.02136) | ICLR 2017 | avail [tensorflow & torch](docs/pages/getting_started.ipynb)|
 | Mahalanobis | [A Simple Unified Framework for Detecting Out-of-Distribution Samples and Adversarial Attacks](http://arxiv.org/abs/1807.03888) | NeurIPS 2018 | avail [tensorflow](docs/notebooks/tensorflow/demo_mahalanobis_tf.ipynb) or  [torch](docs/notebooks/torch/demo_mahalanobis_torch.ipynb)|
 | Energy | [Energy-based Out-of-distribution Detection](http://arxiv.org/abs/2010.03759) | NeurIPS 2020 |avail [tensorflow](docs/notebooks/tensorflow/demo_energy_tf.ipynb) or  [torch](docs/notebooks/torch/demo_energy_torch.ipynb)  |
-| Odin | [Enhancing The Reliability of Out-of-distribution Image Detection in Neural Networks](http://arxiv.org/abs/1706.02690) | ICLR 2018 |avail [tensorflow](docs/notebooks/tensorflow/demo_odin_tf.ipynb) or  [torch](docs/notebooks/torch/demo_odin_torch.ipynb) |
+| Odin | [Enhancing The Reliability of Out-of-distribution Image Detection in Neural Networks](http://arxiv.org/abs/1706.02690) | ICLR 2018 | avail [tensorflow](docs/notebooks/tensorflow/demo_odin_tf.ipynb) or  [torch](docs/notebooks/torch/demo_odin_torch.ipynb) |
 | DKNN | [Out-of-Distribution Detection with Deep Nearest Neighbors](http://arxiv.org/abs/2204.06507) | ICML 2022 | avail [tensorflow](docs/notebooks/tensorflow/demo_dknn_tf.ipynb) or  [torch](docs/notebooks/torch/demo_dknn_torch.ipynb) |
 | VIM | [ViM: Out-Of-Distribution with Virtual-logit Matching](http://arxiv.org/abs/2203.10807) | CVPR 2022 |avail [tensorflow](docs/notebooks/tensorflow/demo_vim_tf.ipynb) or  [torch](docs/notebooks/torch/demo_vim_torch.ipynb)  |
 | Entropy | [Likelihood Ratios for Out-of-Distribution Detection](https://proceedings.neurips.cc/paper/2019/hash/1e79596878b2320cac26dd792a6c51c9-Abstract.html) | NeurIPS 2019 |avail [tensorflow](docs/notebooks/tensorflow/demo_entropy_tf.ipynb) or  [torch](docs/notebooks/torch/demo_entropy_torch.ipynb)  |
 | GODIN | [Generalized ODIN: Detecting Out-of-Distribution Image Without Learning From Out-of-Distribution Data](https://ieeexplore.ieee.org/document/9156473/) | CVPR 2020 | planned |
 | ReAct | [ReAct: Out-of-distribution Detection With Rectified Activations](http://arxiv.org/abs/2111.12797) | NeurIPS 2021 | avail [tensorflow](docs/notebooks/tensorflow/demo_react_tf.ipynb) or  [torch](docs/notebooks/torch/demo_react_torch.ipynb) |
 | NMD | [Neural Mean Discrepancy for Efficient Out-of-Distribution Detection](https://openaccess.thecvf.com/content/CVPR2022/html/Dong_Neural_Mean_Discrepancy_for_Efficient_Out-of-Distribution_Detection_CVPR_2022_paper.html) | CVPR 2022 | planned |
-| Gram | [Detecting Out-of-Distribution Examples with Gram Matrices](https://proceedings.mlr.press/v119/sastry20a.html) | ICML 2020 | planned |
-
+| Gram | [Detecting Out-of-Distribution Examples with Gram Matrices](https://proceedings.mlr.press/v119/sastry20a.html) | ICML 2020 | avail [tensorflow](docs/notebooks/tensorflow/demo_gram_tf.ipynb) or  [torch](docs/notebooks/torch/demo_gram_torch.ipynb) |
+| GEN | [GEN: Pushing the Limits of Softmax-Based Out-of-Distribution Detection](https://openaccess.thecvf.com/content/CVPR2023/html/Liu_GEN_Pushing_the_Limits_of_Softmax-Based_Out-of-Distribution_Detection_CVPR_2023_paper.html) | CVPR 2023 | avail [tensorflow](docs/notebooks/tensorflow/demo_gen_tf.ipynb) or [torch](docs/notebooks/torch/demo_gen_torch.ipynb) |
+| RMDS | [A Simple Fix to Mahalanobis Distance for Improving Near-OOD Detection](https://arxiv.org/abs/2106.09022) | preprint | avail [tensorflow](docs/notebooks/tensorflow/demo_rmds_tf.ipynb) or [torch](docs/notebooks/torch/demo_rmds_torch.ipynb) |
+| SHE | [Out-of-Distribution Detection based on In-Distribution Data Patterns Memorization with Modern Hopfield Energy](https://openreview.net/forum?id=KkazG4lgKL) | ICLR 2023 | avail [tensorflow](docs/notebooks/tensorflow/demo_she_tf.ipynb) or [torch](docs/notebooks/torch/demo_she_torch.ipynb) |
+| ASH | [Extremely Simple Activation Shaping for Out-of-Distribution Detection](http://arxiv.org/abs/2310.00227) | ICLR 2023 | avail [tensorflow](docs/notebooks/tensorflow/demo_ash_tf.ipynb) or [torch](docs/notebooks/torch/demo_ash_torch.ipynb) |
+| SCALE | [Scaling for Training Time and Post-hoc Out-of-distribution Detection Enhancement](https://arxiv.org/abs/2111.12797) | ICLR 2024 | avail [tensorflow](docs/notebooks/tensorflow/demo_scale_tf.ipynb) or [torch](docs/notebooks/torch/demo_scale_torch.ipynb) |
 
 
 
@@ -252,6 +365,19 @@ This project received funding from the French ”Investing for the Future – PI
 
 The library was created by Paul Novello to streamline DEEL research on post-hoc deep OOD methods and foster their adoption by DEEL industrial partners. He was soon joined by Yann Pequignot, Yannick Prudent, Corentin Friedrich and Matthieu Le Goff.
 
+# Citation
+
+If you use OODEEL for your research project, please consider citing:
+```
+@misc{oodeel,
+  author = {Novello, Paul and Prudent, Yannick and Friedrich, Corentin and Pequignot, Yann and Le Goff, Matthieu},
+  title = {OODEEL, a simple, compact, and hackable post-hoc deep OOD detection for already trained tensorflow or pytorch image classifiers.},
+  year = {2023},
+  publisher = {GitHub},
+  journal = {GitHub repository},
+  howpublished = {\url{https://github.com/deel-ai/oodeel}},
+}
+```
 # License
 
 The package is released under [MIT license](LICENSE).

oodeel-0.1.1/PKG-INFO → oodeel-0.3.0/README.md

@@ -1,24 +1,3 @@
-Metadata-Version: 2.1
-Name: oodeel
-Version: 0.1.1
-Summary: Simple, compact, and hackable post-hoc deep OOD detection for alreadytrained tensorflow or pytorch image classifiers.
-Author: DEEL Core Team
-Author-email: paul.novello@irt-saintexupery.com
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Description-Content-Type: text/markdown
-Provides-Extra: dev
-Provides-Extra: tensorflow-dev
-Provides-Extra: torch-dev
-Provides-Extra: tensorflow
-Provides-Extra: torch
-Provides-Extra: docs
-License-File: LICENSE
-
 
 <!-- Banner section -->
 <div align="center">
@@ -33,29 +12,23 @@ License-File: LICENSE
 <!-- Badge section -->
 <div align="center">
     <a href="#">
-        <img src="https://img.shields.io/badge/python-3.8%2B-blue">
-    </a>
+        <img src="https://img.shields.io/badge/python-3.8%2B-blue"></a>
     <a href="https://github.com/deel-ai/oodeel/actions/workflows/python-linters.yml">
-        <img alt="Flake8" src="https://github.com/deel-ai/oodeel/actions/workflows/python-linters.yml/badge.svg">
-    </a>
+        <img alt="Flake8" src="https://github.com/deel-ai/oodeel/actions/workflows/python-linters.yml/badge.svg"></a>
     <a href="https://github.com/deel-ai/oodeel/actions/workflows/python-tests-tf.yml">
-        <img alt="Tests tf" src="https://github.com/deel-ai/oodeel/actions/workflows/python-tests-tf.yml/badge.svg">
-    </a>
+        <img alt="Tests tf" src="https://github.com/deel-ai/oodeel/actions/workflows/python-tests-tf.yml/badge.svg"></a>
     <a href="https://github.com/deel-ai/oodeel/actions/workflows/python-tests-torch.yml">
-        <img alt="Tests torch" src="https://github.com/deel-ai/oodeel/actions/workflows/python-tests-torch.yml/badge.svg">
-    </a>
+        <img alt="Tests torch" src="https://github.com/deel-ai/oodeel/actions/workflows/python-tests-torch.yml/badge.svg"></a>
     <a href="https://github.com/deel-ai/oodeel/actions/workflows/python-coverage-shield.yml">
-        <img alt="Coverage" src="https://github.com/deel-ai/oodeel/raw/gh-shields/coverage.svg">
-    </a>
+        <img alt="Coverage" src="https://github.com/deel-ai/oodeel/raw/gh-shields/coverage.svg"></a>
     <a href="https://github.com/deel-ai/oodeel/blob/master/LICENSE">
-        <img alt="License MIT" src="https://img.shields.io/badge/License-MIT-efefef">
-    </a>
+        <img alt="License MIT" src="https://img.shields.io/badge/License-MIT-efefef"></a>
 </div>
 <br>
 
 <!-- Short description of your library -->
 
-<b>Oodeel</b> is a library that performs post-hoc deep OOD detection on already trained neural network image classifiers. The philosophy of the library is to favor quality over quantity and to foster easy adoption. As a result, we provide a simple, compact and easily customizable API and carefully integrate and test each proposed baseline into a coherent framework that is designed to enable their use in tensorflow **and** pytorch. You can find the documentation [here](https://deel-ai.github.io/oodeel/).
+<b>Oodeel</b> is a library that performs post-hoc deep OOD (Out-of-Distribution) detection on already trained neural network image classifiers. The philosophy of the library is to favor quality over quantity and to foster easy adoption. As a result, we provide a simple, compact and easily customizable API and carefully integrate and test each proposed baseline into a coherent framework that is designed to enable their use in tensorflow **and** pytorch. You can find the documentation [here](https://deel-ai.github.io/oodeel/).
 
 ```python
 from oodeel.methods import MLS
@@ -75,7 +48,8 @@ scores, info = mls.score(ds) # ds is a tf.data.Dataset or a torch.DataLoader
 - [Contributing](#contributing)
 - [See Also](#see-also)
 - [Acknowledgments](#acknowledgments)
-- [Creator](#creator)
+- [Creators](#creators)
+- [Citation](#citation)
 - [License](#license)
 
 # Installation
@@ -194,15 +168,19 @@ Currently, **oodeel** includes the following baselines:
 | MSP | [A Baseline for Detecting Misclassified and Out-of-Distribution Examples in Neural Networks](http://arxiv.org/abs/1610.02136) | ICLR 2017 | avail [tensorflow & torch](docs/pages/getting_started.ipynb)|
 | Mahalanobis | [A Simple Unified Framework for Detecting Out-of-Distribution Samples and Adversarial Attacks](http://arxiv.org/abs/1807.03888) | NeurIPS 2018 | avail [tensorflow](docs/notebooks/tensorflow/demo_mahalanobis_tf.ipynb) or  [torch](docs/notebooks/torch/demo_mahalanobis_torch.ipynb)|
 | Energy | [Energy-based Out-of-distribution Detection](http://arxiv.org/abs/2010.03759) | NeurIPS 2020 |avail [tensorflow](docs/notebooks/tensorflow/demo_energy_tf.ipynb) or  [torch](docs/notebooks/torch/demo_energy_torch.ipynb)  |
-| Odin | [Enhancing The Reliability of Out-of-distribution Image Detection in Neural Networks](http://arxiv.org/abs/1706.02690) | ICLR 2018 |avail [tensorflow](docs/notebooks/tensorflow/demo_odin_tf.ipynb) or  [torch](docs/notebooks/torch/demo_odin_torch.ipynb) |
+| Odin | [Enhancing The Reliability of Out-of-distribution Image Detection in Neural Networks](http://arxiv.org/abs/1706.02690) | ICLR 2018 | avail [tensorflow](docs/notebooks/tensorflow/demo_odin_tf.ipynb) or  [torch](docs/notebooks/torch/demo_odin_torch.ipynb) |
 | DKNN | [Out-of-Distribution Detection with Deep Nearest Neighbors](http://arxiv.org/abs/2204.06507) | ICML 2022 | avail [tensorflow](docs/notebooks/tensorflow/demo_dknn_tf.ipynb) or  [torch](docs/notebooks/torch/demo_dknn_torch.ipynb) |
 | VIM | [ViM: Out-Of-Distribution with Virtual-logit Matching](http://arxiv.org/abs/2203.10807) | CVPR 2022 |avail [tensorflow](docs/notebooks/tensorflow/demo_vim_tf.ipynb) or  [torch](docs/notebooks/torch/demo_vim_torch.ipynb)  |
 | Entropy | [Likelihood Ratios for Out-of-Distribution Detection](https://proceedings.neurips.cc/paper/2019/hash/1e79596878b2320cac26dd792a6c51c9-Abstract.html) | NeurIPS 2019 |avail [tensorflow](docs/notebooks/tensorflow/demo_entropy_tf.ipynb) or  [torch](docs/notebooks/torch/demo_entropy_torch.ipynb)  |
 | GODIN | [Generalized ODIN: Detecting Out-of-Distribution Image Without Learning From Out-of-Distribution Data](https://ieeexplore.ieee.org/document/9156473/) | CVPR 2020 | planned |
 | ReAct | [ReAct: Out-of-distribution Detection With Rectified Activations](http://arxiv.org/abs/2111.12797) | NeurIPS 2021 | avail [tensorflow](docs/notebooks/tensorflow/demo_react_tf.ipynb) or  [torch](docs/notebooks/torch/demo_react_torch.ipynb) |
 | NMD | [Neural Mean Discrepancy for Efficient Out-of-Distribution Detection](https://openaccess.thecvf.com/content/CVPR2022/html/Dong_Neural_Mean_Discrepancy_for_Efficient_Out-of-Distribution_Detection_CVPR_2022_paper.html) | CVPR 2022 | planned |
-| Gram | [Detecting Out-of-Distribution Examples with Gram Matrices](https://proceedings.mlr.press/v119/sastry20a.html) | ICML 2020 | planned |
-
+| Gram | [Detecting Out-of-Distribution Examples with Gram Matrices](https://proceedings.mlr.press/v119/sastry20a.html) | ICML 2020 | avail [tensorflow](docs/notebooks/tensorflow/demo_gram_tf.ipynb) or  [torch](docs/notebooks/torch/demo_gram_torch.ipynb) |
+| GEN | [GEN: Pushing the Limits of Softmax-Based Out-of-Distribution Detection](https://openaccess.thecvf.com/content/CVPR2023/html/Liu_GEN_Pushing_the_Limits_of_Softmax-Based_Out-of-Distribution_Detection_CVPR_2023_paper.html) | CVPR 2023 | avail [tensorflow](docs/notebooks/tensorflow/demo_gen_tf.ipynb) or [torch](docs/notebooks/torch/demo_gen_torch.ipynb) |
+| RMDS | [A Simple Fix to Mahalanobis Distance for Improving Near-OOD Detection](https://arxiv.org/abs/2106.09022) | preprint | avail [tensorflow](docs/notebooks/tensorflow/demo_rmds_tf.ipynb) or [torch](docs/notebooks/torch/demo_rmds_torch.ipynb) |
+| SHE | [Out-of-Distribution Detection based on In-Distribution Data Patterns Memorization with Modern Hopfield Energy](https://openreview.net/forum?id=KkazG4lgKL) | ICLR 2023 | avail [tensorflow](docs/notebooks/tensorflow/demo_she_tf.ipynb) or [torch](docs/notebooks/torch/demo_she_torch.ipynb) |
+| ASH | [Extremely Simple Activation Shaping for Out-of-Distribution Detection](http://arxiv.org/abs/2310.00227) | ICLR 2023 | avail [tensorflow](docs/notebooks/tensorflow/demo_ash_tf.ipynb) or [torch](docs/notebooks/torch/demo_ash_torch.ipynb) |
+| SCALE | [Scaling for Training Time and Post-hoc Out-of-distribution Detection Enhancement](https://arxiv.org/abs/2111.12797) | ICLR 2024 | avail [tensorflow](docs/notebooks/tensorflow/demo_scale_tf.ipynb) or [torch](docs/notebooks/torch/demo_scale_torch.ipynb) |
 
 
 
@@ -252,6 +230,19 @@ This project received funding from the French ”Investing for the Future – PI
 
 The library was created by Paul Novello to streamline DEEL research on post-hoc deep OOD methods and foster their adoption by DEEL industrial partners. He was soon joined by Yann Pequignot, Yannick Prudent, Corentin Friedrich and Matthieu Le Goff.
 
+# Citation
+
+If you use OODEEL for your research project, please consider citing:
+```
+@misc{oodeel,
+  author = {Novello, Paul and Prudent, Yannick and Friedrich, Corentin and Pequignot, Yann and Le Goff, Matthieu},
+  title = {OODEEL, a simple, compact, and hackable post-hoc deep OOD detection for already trained tensorflow or pytorch image classifiers.},
+  year = {2023},
+  publisher = {GitHub},
+  journal = {GitHub repository},
+  howpublished = {\url{https://github.com/deel-ai/oodeel}},
+}
+```
 # License
 
 The package is released under [MIT license](LICENSE).

{oodeel-0.1.1 → oodeel-0.3.0}/oodeel/__init__.py

@@ -25,4 +25,4 @@ oodeel
 -------
 """
 
-__version__ = "0.1.1"
+__version__ = "0.3.0"

{oodeel-0.1.1 → oodeel-0.3.0}/oodeel/datasets/__init__.py

@@ -20,4 +20,5 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
-from .ooddataset import OODDataset
+from .data_handler import load_data_handler
+from .deprecated.DEPRECATED_ooddataset import OODDataset