oodeel 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

oodeel/preprocess/tf_preprocess.py

@@ -0,0 +1,95 @@
+# -*- coding: utf-8 -*-
+# Copyright IRT Antoine de Saint Exupéry et Université Paul Sabatier Toulouse III - All
+# rights reserved. DEEL is a research program operated by IVADO, IRT Saint Exupéry,
+# CRIAQ and ANITI - https://www.deel.ai/
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# 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.
+import numpy as np
+import tensorflow as tf
+
+from ..types import Optional
+from ..types import Tuple
+
+
+class TFRandomPatchPermutation:
+    def __init__(self, patch_size: Tuple[int] = (8, 8)):
+        """Randomly permute the patches of an image. This transformation is used in NMD
+        paper to artificially craft OOD data from ID images.
+
+        Source (NMD paper):
+            "Neural Mean Discrepancy for Efficient Out-of-Distribution Detection"
+            [link](https://arxiv.org/pdf/2104.11408.pdf)
+
+        Args:
+            patch_size (Tuple[int], optional): Patch dimensions (h, w), should be
+                divisors of the image dimensions (H, W). Defaults to (8, 8).
+        """
+        self.patch_size = patch_size
+
+    def __call__(self, tensor: tf.Tensor, seed: Optional[int] = None):
+        """Apply random patch permutation.
+
+        Args:
+            tensor (tf.Tensor): Tensor of shape [H, W, C]
+            seed (Optinal[int]): Seed number to set for the permutation if not None.
+
+        Returns:
+            tf.Tensor: Transformed tensor.
+        """
+        h, w = self.patch_size
+        H, W, C = tensor.shape
+        tensor_ = tensor
+
+        # raise warning if patch dimensions are not divisors of image dimensions
+        if H % h != 0:
+            print(
+                f"Warning! Patch height ({h}) should be a divisor of the image height"
+                + f" ({H}). Zero padding will be added to get the correct output shape."
+            )
+            tensor_ = tensor[: -(H % h)]
+        if W % w != 0:
+            print(
+                f"Warning! Patch width ({w}) should be a divisor of the image width"
+                + f" ({W}). Zero padding will be added to get the correct output shape."
+            )
+            tensor_ = tensor_[:, : -(W % w)]
+
+        # === patch permutation ===
+        # divide the batch of images into non-overlapping patches
+        # => [num_patches, h * w, C]
+        u = tf.transpose(
+            tf.reshape(tensor_, (H // h, h, W // w, w, C)), (0, 2, 1, 3, 4)
+        )
+        u = tf.reshape(u, (-1, h * w, C))
+
+        # permute the patches of each image in the batch
+        # => [num_patches, h * w, C]
+        # Note: we use numpy rng for deterministic index shuffling because
+        #       `tf.stateless_shuffle` is still experimental
+        g = np.random.default_rng(seed=seed)
+        indices = np.arange(u.shape[0])
+        g.shuffle(indices)
+        pu = tf.gather(u, indices)
+
+        # fold the permuted patches back together
+        # => [H, W, C]
+        f = tf.transpose(tf.reshape(pu, (H // h, W // w, h, w, C)), (0, 2, 1, 3, 4))
+        f = tf.reshape(f, tensor_.shape)
+        f = tf.pad(f, tf.constant([[0, H % h], [0, W % w], [0, 0]]))
+        return f

oodeel/preprocess/torch_preprocess.py

@@ -0,0 +1,97 @@
+# -*- coding: utf-8 -*-
+# Copyright IRT Antoine de Saint Exupéry et Université Paul Sabatier Toulouse III - All
+# rights reserved. DEEL is a research program operated by IVADO, IRT Saint Exupéry,
+# CRIAQ and ANITI - https://www.deel.ai/
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# 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.
+import torch
+import torch.nn.functional as F
+
+from ..types import Optional
+from ..types import Tuple
+
+
+class TorchRandomPatchPermutation:
+    def __init__(self, patch_size: Tuple[int] = (8, 8)):
+        """Randomly permute the patches of an image. This transformation is used in NMD
+        paper to artificially craft OOD data from ID images.
+
+        Source (NMD paper):
+            "Neural Mean Discrepancy for Efficient Out-of-Distribution Detection"
+            [link](https://arxiv.org/pdf/2104.11408.pdf)
+
+        Args:
+            patch_size (Tuple[int], optional): Patch dimensions (h, w), should be
+                divisors of the image dimensions (H, W). Defaults to (8, 8).
+        """
+        self.patch_size = patch_size
+
+    def __call__(self, tensor: torch.Tensor, seed: Optional[int] = None):
+        """Apply random patch permutation.
+
+        Args:
+            tensor (torch.Tensor): Tensor of shape [C, H, W]
+            seed (Optinal[int]): Seed number to set for the permutation if not None.
+
+        Returns:
+            torch.Tensor: Transformed tensor.
+        """
+        h, w = self.patch_size
+        H, W, _ = tensor.shape
+
+        # set generator if seed is not None
+        g = None
+        if seed is not None:
+            g = torch.Generator(device=tensor.device)
+            g.manual_seed(seed)
+
+        # raise warning if patch dimensions are not divisors of image dimensions
+        if H % h != 0:
+            print(
+                f"Warning! Patch height ({h}) should be a divisor of the image height"
+                + f" ({H}). Zero padding will be added to get the correct output shape."
+            )
+        if W % w != 0:
+            print(
+                f"Warning! Patch width ({w}) should be a divisor of the image width"
+                + f" ({W}). Zero padding will be added to get the correct output shape."
+            )
+
+        # === patch permutation ===
+        # [C, H, W] => [1, C, H, W]
+        x = tensor.unsqueeze(0)
+        # divide the batch of images into non-overlapping patches
+        # => [1, h * w, num_patches]
+        u = F.unfold(x, kernel_size=self.patch_size, stride=self.patch_size, padding=0)
+        # permute the patches of each image in the batch
+        # => [1, h * w, num_patches]
+        pu = torch.cat(
+            [b_[:, torch.randperm(b_.shape[-1], generator=g)][None, ...] for b_ in u],
+            dim=0,
+        )
+        # fold the permuted patches back together
+        # => [1, C, H, W]
+        f = F.fold(
+            pu,
+            x.shape[-2:],
+            kernel_size=self.patch_size,
+            stride=self.patch_size,
+            padding=0,
+        )
+        return f.squeeze(0)

oodeel/utils/operator.py

@@ -221,6 +221,11 @@ class Operator(ABC):
         "unsqueeze/expand_dim along dim"
         raise NotImplementedError()
 
+    @staticmethod
+    def squeeze(tensor: TensorType, dim: int = None) -> TensorType:
+        "squeeze along dim"
+        raise NotImplementedError()
+
     @staticmethod
     def abs(tensor: TensorType) -> TensorType:
         "compute absolute value"
@@ -234,3 +239,15 @@ class Operator(ABC):
     ) -> TensorType:
         "Applies where function to condition"
         raise NotImplementedError()
+
+    @staticmethod
+    @abstractmethod
+    def avg_pool_2d(tensor: TensorType) -> TensorType:
+        """Perform avg pool in 2d as in torch.nn.functional.adaptive_avg_pool2d"""
+        raise NotImplementedError()
+
+    @staticmethod
+    @abstractmethod
+    def log(tensor: TensorType) -> TensorType:
+        """Perform log"""
+        raise NotImplementedError()

oodeel/utils/tf_operator.py

@@ -231,6 +231,11 @@ class TFOperator(Operator):
         "expand_dim along dim"
         return tf.expand_dims(tensor, dim)
 
+    @staticmethod
+    def squeeze(tensor: TensorType, dim: int = None) -> tf.Tensor:
+        "expand_dim along dim"
+        return tf.squeeze(tensor, dim)
+
     @staticmethod
     def abs(tensor: TensorType) -> tf.Tensor:
         "compute absolute value"
@@ -248,3 +253,13 @@ class TFOperator(Operator):
     @staticmethod
     def percentile(x, q):
         return tfp.stats.percentile(x, q)
+
+    @staticmethod
+    def avg_pool_2d(tensor: TensorType) -> tf.Tensor:
+        """Perform avg pool in 2d as in torch.nn.functional.adaptive_avg_pool2d"""
+        return tf.reduce_mean(tensor, axis=(-3, -2))
+
+    @staticmethod
+    def log(tensor: TensorType) -> tf.Tensor:
+        """Perform log"""
+        return tf.math.log(tensor)

oodeel/utils/tf_training_tools.py

@@ -81,8 +81,8 @@ def get_toy_keras_convnet(num_classes: int) -> tf.keras.Model:
 def train_tf_model(
     train_data: tf.data.Dataset,
     model: Union[tf.keras.Model, str],
-    input_shape: tuple,
-    num_classes: int,
+    input_shape: tuple = None,
+    num_classes: int = None,
     batch_size: int = 128,
     epochs: int = 50,
     loss: str = "sparse_categorical_crossentropy",

oodeel/utils/torch_operator.py

@@ -254,6 +254,15 @@ class TorchOperator(Operator):
         "unsqueeze along dim"
         return torch.unsqueeze(tensor, dim)
 
+    @staticmethod
+    def squeeze(tensor: TensorType, dim: int = None) -> torch.Tensor:
+        "squeeze along dim"
+
+        if dim is None:
+            return torch.squeeze(tensor)
+
+        return torch.squeeze(tensor, dim)
+
     @staticmethod
     def abs(tensor: TensorType) -> torch.Tensor:
         "compute absolute value"
@@ -267,3 +276,13 @@ class TorchOperator(Operator):
     ) -> torch.Tensor:
         "Applies where function , to condition"
         return torch.where(condition, input, other)
+
+    @staticmethod
+    def avg_pool_2d(tensor: TensorType) -> torch.Tensor:
+        """Perform avg pool in 2d as in torch.nn.functional.adaptive_avg_pool2d"""
+        return torch.mean(tensor, dim=(-2, -1))
+
+    @staticmethod
+    def log(tensor: TensorType) -> torch.Tensor:
+        """Perform log"""
+        return torch.log(tensor)

{oodeel-0.2.0.dist-info → oodeel-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: oodeel
-Version: 0.2.0
+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
@@ -12,104 +12,126 @@ 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: faiss_cpu
 Requires-Dist: numpy
-Requires-Dist: scikit-learn
+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: ipython ; extra == 'dev'
-Requires-Dist: ipykernel ; extra == 'dev'
-Requires-Dist: pytest ; extra == 'dev'
-Requires-Dist: pylint ; 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: bump2version ; extra == 'dev'
-Requires-Dist: docsig ; extra == 'dev'
-Requires-Dist: no-implicit-optional ; extra == 'dev'
-Requires-Dist: tensorflow ; extra == 'dev'
-Requires-Dist: tensorflow-datasets ; extra == 'dev'
-Requires-Dist: tensorflow-probability ; extra == 'dev'
-Requires-Dist: timm ; extra == 'dev'
-Requires-Dist: torch ; extra == 'dev'
-Requires-Dist: torchvision ; extra == 'dev'
-Provides-Extra: docs
-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'
-Provides-Extra: tensorflow
-Requires-Dist: tensorflow ; extra == 'tensorflow'
-Requires-Dist: tensorflow-datasets ; extra == 'tensorflow'
-Requires-Dist: tensorflow-probability ; extra == 'tensorflow'
+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: ipython ; extra == 'tensorflow-dev'
-Requires-Dist: ipykernel ; extra == 'tensorflow-dev'
-Requires-Dist: pytest ; extra == 'tensorflow-dev'
-Requires-Dist: pylint ; 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: bump2version ; extra == 'tensorflow-dev'
-Requires-Dist: docsig ; extra == 'tensorflow-dev'
-Requires-Dist: no-implicit-optional ; extra == 'tensorflow-dev'
-Requires-Dist: tensorflow ; extra == 'tensorflow-dev'
-Requires-Dist: tensorflow-datasets ; extra == 'tensorflow-dev'
-Requires-Dist: tensorflow-probability ; extra == 'tensorflow-dev'
-Provides-Extra: torch
-Requires-Dist: timm ; extra == 'torch'
-Requires-Dist: torch ; extra == 'torch'
-Requires-Dist: torchvision ; extra == 'torch'
+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: ipython ; extra == 'torch-dev'
-Requires-Dist: ipykernel ; extra == 'torch-dev'
-Requires-Dist: pytest ; extra == 'torch-dev'
-Requires-Dist: pylint ; 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: bump2version ; extra == 'torch-dev'
-Requires-Dist: docsig ; extra == 'torch-dev'
-Requires-Dist: no-implicit-optional ; extra == 'torch-dev'
-Requires-Dist: timm ; extra == 'torch-dev'
-Requires-Dist: torch ; extra == 'torch-dev'
-Requires-Dist: torchvision ; 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
+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 -->
@@ -125,29 +147,23 @@ Requires-Dist: torchvision ; extra == 'torch-dev'
 <!-- 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
@@ -167,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
@@ -294,7 +311,11 @@ Currently, **oodeel** includes the following baselines:
 | 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 | 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) |
 
 
 
@@ -344,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).