pyAgrum-nightly 2.3.1.9.dev202512261765915415__cp310-abi3-macosx_10_15_x86_64.whl

pyagrum/explain/notebook/_showShapValues.py

@@ -0,0 +1,97 @@
+############################################################################
+#   This file is part of the aGrUM/pyAgrum library.                        #
+#                                                                          #
+#   Copyright (c) 2005-2025 by                                             #
+#       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 #
+#       - Christophe GONZALES(_at_AMU)                                     #
+#                                                                          #
+#   The aGrUM/pyAgrum library is free software; you can redistribute it    #
+#   and/or modify it under the terms of either :                           #
+#                                                                          #
+#    - the GNU Lesser General Public License as published by               #
+#      the Free Software Foundation, either version 3 of the License,      #
+#      or (at your option) any later version,                              #
+#    - the MIT license (MIT),                                              #
+#    - or both in dual license, as here.                                   #
+#                                                                          #
+#   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    #
+#                                                                          #
+#   This aGrUM/pyAgrum library is distributed in the hope that it will be  #
+#   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          #
+#   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or 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.                                        #
+#                                                                          #
+#   See LICENCES for more details.                                         #
+#                                                                          #
+#   SPDX-FileCopyrightText: Copyright 2005-2025                            #
+#       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 #
+#       - Christophe GONZALES(_at_AMU)                                     #
+#   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      #
+#                                                                          #
+#   Contact  : info_at_agrum_dot_org                                       #
+#   homepage : http://agrum.gitlab.io                                      #
+#   gitlab   : https://gitlab.com/agrumery/agrum                           #
+#                                                                          #
+############################################################################
+
+import pyagrum as gum
+import pyagrum.lib.notebook as gnb
+from pyagrum.lib.bn2graph import BN2dot
+from pyagrum.explain import Explanation
+
+import matplotlib.pyplot as plt
+
+
+def showShapValues(bn: gum.BayesNet, expl: Explanation | dict, cmap="plasma", y=1):
+  """
+  Show the Shap values in the DAG of the BN
+  Parameters
+  ----------
+  bn : pyagrum.BayesNet
+      The Bayesian network
+  expl: Explanation | dict[str,float]
+      The Shap values to each variable
+  cmap: str
+      Name of the Matplotlib colormap used for coloring the nodes.
+  y: int
+      The target class for which the Shap values are computed (default is 1).
+      y is ignored if `expl` is a dict.
+
+  Raises
+  ------
+  TypeError
+      If bn is not a gum.BayesNet, if expl is neither an Explanation nor a dict, or if expl is an Explanation and y is not an integer.
+  IndexError
+      If expl is an Explanation and y is outside the valid class range.
+  """
+
+  if not isinstance(bn, gum.BayesNet):
+    raise TypeError(f"The parameter bn must be a gum.BayesNet but got {type(bn)}")
+  if isinstance(expl, Explanation):
+    if isinstance(y, int):
+      if y < min(expl.keys()) or y > max(expl.keys()):
+        raise IndexError(
+          f"Target index y={y} is out of bounds; expected {min(expl.keys())} <= y < {max(expl.keys()) + 1}."
+        )
+    else:
+      raise TypeError("`y`must be an integer but got {}".format(y))
+    importances = expl.importances[y]
+
+  elif isinstance(expl, dict):
+    importances = expl
+
+  else:
+    raise TypeError(f"The parameter expl must be either an Explanation object or a dict but got {type(expl)}")
+
+  norm_color = {}
+  raw = list(importances.values())
+  norm = [float(i) / sum(raw) for i in raw]
+  for i, feat in enumerate(list(importances.keys())):
+    norm_color[feat] = norm[i]
+  cm = plt.get_cmap(cmap)
+  g = BN2dot(bn, nodeColor=norm_color, cmapNode=cm)
+  gnb.showGraph(g)

pyagrum/explain/notebook/_waterfall.py

@@ -0,0 +1,220 @@
+############################################################################
+#   This file is part of the aGrUM/pyAgrum library.                        #
+#                                                                          #
+#   Copyright (c) 2005-2025 by                                             #
+#       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 #
+#       - Christophe GONZALES(_at_AMU)                                     #
+#                                                                          #
+#   The aGrUM/pyAgrum library is free software; you can redistribute it    #
+#   and/or modify it under the terms of either :                           #
+#                                                                          #
+#    - the GNU Lesser General Public License as published by               #
+#      the Free Software Foundation, either version 3 of the License,      #
+#      or (at your option) any later version,                              #
+#    - the MIT license (MIT),                                              #
+#    - or both in dual license, as here.                                   #
+#                                                                          #
+#   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    #
+#                                                                          #
+#   This aGrUM/pyAgrum library is distributed in the hope that it will be  #
+#   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          #
+#   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or 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.                                        #
+#                                                                          #
+#   See LICENCES for more details.                                         #
+#                                                                          #
+#   SPDX-FileCopyrightText: Copyright 2005-2025                            #
+#       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 #
+#       - Christophe GONZALES(_at_AMU)                                     #
+#   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      #
+#                                                                          #
+#   Contact  : info_at_agrum_dot_org                                       #
+#   homepage : http://agrum.gitlab.io                                      #
+#   gitlab   : https://gitlab.com/agrumery/agrum                           #
+#                                                                          #
+############################################################################
+
+import pyagrum as gum
+from pyagrum.explain._Explanation import Explanation
+from typing import Callable, Dict
+import numpy as np
+
+import matplotlib.pyplot as plt
+from matplotlib.patches import Polygon
+
+
+def _POSTERIOR(y: int, func: str) -> str:
+  return f"logit($p(y={y} \\mid x)$)" if func == "_logit" else f"$p(y={y} \\mid x)$"
+
+
+def _JOIN(func: str) -> str:
+  return "log($p(x \\mid \\theta)$)" if func == "_log" else "$p(x \\mid \\theta)$"
+
+
+def _FMT(func: str) -> str:
+  return ".2e" if func == "_identity" else ".2f"
+
+
+def waterfall(explanation: Explanation, y: int = 1, ax=None, real_values: Dict = None):
+  """
+  Plots a waterfall chart of the SHAP/SHALL values.
+
+  Parameters:
+  ----------
+  explanation : Explanation
+      The explanation object containing the SHAP/SHALL values.
+  y : int, optional
+      If the values type of the explanation is SHALL, then y is ignored.
+      Else it is the class for which to plot the SHAP values.
+  ax : matplotlib.Axes, optional
+      The matplotlib Axes object to plot on (default is None, which creates a new figure).
+  real_values : Dict, optional
+      Dictionary used to display custum values for each feature.
+      For example, useful when continuous values have been discretized but you still want to show the original continuous values from the database.
+      The keys of the dictionary must match the keys in the Explanation object, and the values are the values you want to display on the plot.
+
+  Raises :
+  ------
+  TypeError : If `explanation` is not an Explanation object or if `y` is not an integer.
+  IndexError : If `y` is an integer but out of bounds for the explanation keys.
+  """
+
+  if not isinstance(explanation, Explanation):
+    raise TypeError("`explanation` must be an Explanation object but got {}".format(type(explanation)))
+  if explanation.values_type == "SHAP":
+    if isinstance(y, int):
+      if y < min(explanation.keys()) or y > max(explanation.keys()):
+        raise IndexError(f"Target index y={y} is out of bounds; expected 0 <= y < {max(explanation.keys()) + 1}.")
+    else:
+      raise TypeError("`y`must be an integer but got {}".format(y))
+    values = explanation[y]
+    baseline = explanation.baseline[y]
+  elif explanation.values_type == "SHALL":
+    values = explanation._values
+    baseline = explanation.baseline
+  else:
+    raise ValueError(f"Wrong values type, expected SHAP/SHALL but got {explanation.values_type}")
+
+  # Computing arrow width
+  arrow_width_base = 0.08 * np.max(np.abs(np.array(list(values.values()))))
+
+  # Tri des SHAP values par importance décroissante
+  features = [feature for feature in sorted(values.keys(), key=lambda x: abs(values.get(x)), reverse=True)]
+  y_positions = np.arange(len(values) * 0.25, 0, -0.25)
+
+  # Create the figure and axis if not provided
+  if ax == None:
+    _, ax = plt.subplots()
+
+  # Ligne de base :
+  ax.plot([baseline, baseline], [y_positions[-1] - 0.25, y_positions[0] + 0.25], linestyle="--", color="gray")
+  if explanation.values_type == "SHAP":
+    ax.text(
+      baseline,
+      y_positions[0] + 0.5,
+      f"E({_POSTERIOR(y, explanation.func)}) = {baseline:{_FMT(explanation.func)}}",
+      ha="center",
+      va="bottom",
+      color="gray",
+    )
+  else:
+    ax.text(
+      baseline,
+      y_positions[0] + 0.5,
+      f"E({_JOIN(explanation.func)}) = {baseline:{_FMT(explanation.func)}}",
+      ha="center",
+      va="bottom",
+      color="gray",
+    )
+
+  # Lignes de shapes-values
+  current_x = min_x = max_x = baseline
+
+  for i, feature in enumerate(features):
+    delta = values[feature]
+    x_start = current_x
+    x_end = current_x + delta
+    z = y_positions[i]
+    height = 0.2
+    arrow_width = min(0.4 * abs(delta), arrow_width_base)
+    facecolor, edgecolor, alpha = (
+      (gum.config["notebook", "tensor_color_0"], "#D98383", 1)
+      if values[feature] <= 0
+      else (gum.config["notebook", "tensor_color_1"], "#82D882", -1)
+    )
+
+    # Dessin du polygon
+    polygon = Polygon(
+      [
+        (x_end + alpha * arrow_width, z - height / 2),
+        (x_start, z - height / 2),
+        (x_start, z + height / 2),
+        (x_end + alpha * arrow_width, z + height / 2),
+        (x_end, z),  # pointe
+      ],
+      closed=True,
+      facecolor=facecolor,
+      edgecolor=edgecolor,
+      alpha=0.8,
+      linewidth=2,
+    )
+
+    ax.add_patch(polygon)
+
+    current_x = x_end
+    min_x = min(min_x, current_x)
+    max_x = max(max_x, current_x)
+
+  # Ligne de sortie du modèle
+  ax.plot([current_x, current_x], [y_positions[-1] - 0.25, y_positions[0] + 0.25], linestyle="--", color="Black")
+  if explanation.func == "_logit":
+    ax.text(
+      current_x,
+      y_positions[-1] - 0.5,
+      f"{_POSTERIOR(y, explanation.func)} = {current_x:{_FMT(explanation.func)}}",
+      ha="center",
+      va="bottom",
+      color="Black",
+    )
+  else:
+    ax.text(
+      current_x,
+      y_positions[-1] - 0.5,
+      f"{_JOIN(explanation.func)} = {current_x:{_FMT(explanation.func)}}",
+      ha="center",
+      va="bottom",
+      color="Black",
+    )
+
+  y_tickslabels = []
+
+  for feature in features:
+    feat_shap_value = values[feature]
+    if real_values is not None:
+      value = real_values[feature]
+      if isinstance(real_values[feature], float):
+        value = round(value, 2)
+    else:
+      value = explanation.data[explanation.feature_names.index(feature)]
+
+    y_tickslabels.append(f"{feature} = {value} [{feat_shap_value:{_FMT(explanation.func)}}]")
+
+  ax.set_yticks(y_positions)
+  ax.set_yticklabels(y_tickslabels)
+
+  # Setting the style
+  ax.grid(axis="x", linestyle=":", alpha=0.5)
+  ax.grid(axis="y", alpha=0.5)
+  ax.spines["top"].set_visible(False)
+  ax.spines["bottom"].set_visible(False)
+  ax.spines["left"].set_visible(False)
+  ax.spines["right"].set_visible(False)
+  ax.figure.set_facecolor("White")
+
+  plt.ylim(min(y_positions) - 1, max(y_positions) + 1)
+  delta = max_x - min_x
+  plt.xlim(min_x - 0.05 * delta, max_x + 0.05 * delta)

pyagrum/explain/shapley.py

@@ -0,0 +1,225 @@
+############################################################################
+#   This file is part of the aGrUM/pyAgrum library.                        #
+#                                                                          #
+#   Copyright (c) 2005-2025 by                                             #
+#       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 #
+#       - Christophe GONZALES(_at_AMU)                                     #
+#                                                                          #
+#   The aGrUM/pyAgrum library is free software; you can redistribute it    #
+#   and/or modify it under the terms of either :                           #
+#                                                                          #
+#    - the GNU Lesser General Public License as published by               #
+#      the Free Software Foundation, either version 3 of the License,      #
+#      or (at your option) any later version,                              #
+#    - the MIT license (MIT),                                              #
+#    - or both in dual license, as here.                                   #
+#                                                                          #
+#   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    #
+#                                                                          #
+#   This aGrUM/pyAgrum library is distributed in the hope that it will be  #
+#   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          #
+#   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or 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.                                        #
+#                                                                          #
+#   See LICENCES for more details.                                         #
+#                                                                          #
+#   SPDX-FileCopyrightText: Copyright 2005-2025                            #
+#       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 #
+#       - Christophe GONZALES(_at_AMU)                                     #
+#   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      #
+#                                                                          #
+#   Contact  : info_at_agrum_dot_org                                       #
+#   homepage : http://agrum.gitlab.io                                      #
+#   gitlab   : https://gitlab.com/agrumery/agrum                           #
+#                                                                          #
+############################################################################
+
+import warnings
+
+# ShapValues
+from pyagrum.explain import CausalShapValues, ConditionalShapValues, Explanation, MarginalShapValues
+
+# Calculations
+import pyagrum as gum
+
+# Plots
+import matplotlib.pyplot as plt
+from pyagrum.explain.notebook import bar, beeswarm, waterfall
+
+
+class ShapValues:
+  """
+  Class to compute Shapley values for a target variable in a Bayesian network.
+  """
+
+  def __init__(self, bn, target, logit=True):
+    """
+    Parameters:
+    ------
+    bn : pyagrum.BayesNet
+        The Bayesian Network.
+    target : int | str
+        The node id (or node name) of the target.
+    background : Tuple(pandas.DataFrame, bool) | None
+        A tuple containing a pandas DataFrame and a boolean indicating whether the DataFrame contains labels or positions.
+    sample_size : int
+        The size of the background sample to generate if `background` is None.
+    logit : bool
+        If True, applies the logit transformation to the probabilities.
+
+    Raises:
+    ------
+    TypeError : If bn is not a gum.BayesNet instance or target is not an integer or string.
+    ValueError : If target is not a valid node id in the Bayesian Network.
+    """
+    if not isinstance(bn, gum.BayesNet):
+      raise TypeError("bn must be a gum.BayesNet instance, but got {}".format(type(bn)))
+    if isinstance(target, str):
+      if target not in bn.names():
+        raise ValueError("Target node name '{}' not found in the Bayesian Network.".format(target))
+      target = bn.idFromName(target)  # Convert node name to ID.
+    elif isinstance(target, int):
+      if target not in bn.nodes():
+        raise ValueError("Target node ID {} not found in the Bayesian Network.".format(target))
+    else:
+      raise TypeError("Target must be a node ID (int) or a node name (str), but got {}".format(type(target)))
+    if not isinstance(logit, bool):
+      warnings.warn("logit should be a boolean, unexpected calculation may occur.", UserWarning)
+
+    # Class attributes.
+    self.bn = bn
+    self.target = target
+    self.logit = logit
+
+  @staticmethod
+  def _plot(explanation: Explanation, y: int, plot: bool, plot_importance: bool, percentage: bool, filename: str):
+    ndim = explanation.data.ndim
+    n_figures = sum([plot, plot_importance])
+    plot_index = 0
+    # Local Explanation
+    if n_figures > 0:
+      _, axs = plt.subplots(1, n_figures, figsize=(n_figures * 6, 5))
+      if n_figures == 1:
+        axs = [axs]  # consistent type for axs
+
+      if plot:
+        if ndim == 1:
+          waterfall(explanation=explanation, y=y, ax=axs[plot_index])
+        else:
+          beeswarm(explanation=explanation, y=y, ax=axs[plot_index])
+        plot_index += 1
+      if plot_importance:
+        bar(explanation=explanation, y=y, ax=axs[plot_index], percentage=percentage)
+
+      plt.tight_layout()
+
+      if filename is None:
+        plt.show()
+      else:
+        plt.savefig(filename)
+        plt.close()
+
+  def conditional(
+    self,
+    df,
+    y: int = 1,
+    plot: bool = False,
+    plot_importance: bool = False,
+    percentage: bool = False,
+    filename: str = None,
+  ):
+    """
+    Computes the conditional Shapley values for each variable.
+
+    Parameters:
+    ----------
+    df : pandas DataFrame
+        The input data for which to compute the Shapley values.
+    y : int, optional
+        The target class for which to compute the Shapley values (default is 1).
+    plot : bool, optional
+        If True, plots the waterfall or beeswarm plot depending on the number of rows in df (default is False).
+    plot_importance : bool, optional
+        If True, plots the bar chart of feature importance (default is False).
+    percentage: bool
+      if True, the importance plot is shown in percent.
+    filename : str, optional
+        If provided, saves the plots to the specified filename instead of displaying them.
+
+    Returns:
+    -------
+    Dict[str, float]
+        A dictionary containing the importances of each variable in the input data.
+    """
+    explainer = ConditionalShapValues(self.bn, self.target, self.logit)
+    explanation = explainer.compute((df, True))
+    self._plot(explanation, y, plot, plot_importance, percentage, filename)
+    return explanation.importances[y]
+
+  def marginal(
+    self, df, y=1, sample_size=200, plot=False, plot_importance=False, percentage: bool = False, filename: str = None
+  ):
+    """
+    Computes the marginal Shapley values for each variable.
+
+    Parameters:
+    ----------
+    df : pandas DataFrame
+        The input data for which to compute the Shapley values.
+    y : int, optional
+        The target class for which to compute the Shapley values (default is 1).
+    sample_size : int, optional
+        The number of samples to use for the background data (default is 200).
+    plot : bool, optional
+        If True, plots the waterfall or beeswarm plot depending on the number of rows in df (default is False).
+    plot_importance : bool, optional
+        If True, plots the bar chart of feature importance (default is False).
+    percentage: bool
+      if True, the importance plot is shown in percent.
+
+    Returns:
+    -------
+    Dict[str, float]
+        A dictionary containing the importances of each variable in the input data.
+    """
+    explainer = MarginalShapValues(self.bn, self.target, None, sample_size, self.logit)
+    explanation = explainer.compute((df, True))
+    self._plot(explanation, y, plot, plot_importance, percentage, filename)
+    return explanation.importances[y]
+
+  def causal(
+    self, df, y=1, sample_size=200, plot=False, plot_importance=False, percentage: bool = False, filename: str = None
+  ):
+    """
+    Computes the causal Shapley values for each variable.
+
+    Parameters:
+    ----------
+    df : pandas DataFrame
+        The input data for which to compute the Shapley values.
+    y : int, optional
+        The target class for which to compute the Shapley values (default is 1).
+    sample_size : int, optional
+        The number of samples to use for the background data (default is 200).
+    plot : bool, optional
+        If True, plots the waterfall or beeswarm plot depending on the number of rows in df (default is False).
+    plot_importance : bool, optional
+        If True, plots the bar chart of feature importance (default is False).
+    percentage: bool
+      if True, the importance plot is shown in percent.
+    filename : str, optional
+        If provided, saves the plots to the specified filename instead of displaying them.
+
+    Returns:
+    -------
+    Dict[str, float]
+        A dictionary containing the importances of each variable in the input data.
+    """
+    explainer = CausalShapValues(self.bn, self.target, None, sample_size, self.logit)
+    explanation = explainer.compute((df, True))
+    self._plot(explanation, y, plot, plot_importance, percentage, filename)
+    return explanation.importances[y]

pyagrum/lib/__init__.py

@@ -0,0 +1,46 @@
+############################################################################
+#   This file is part of the aGrUM/pyAgrum library.                        #
+#                                                                          #
+#   Copyright (c) 2005-2025 by                                             #
+#       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 #
+#       - Christophe GONZALES(_at_AMU)                                     #
+#                                                                          #
+#   The aGrUM/pyAgrum library is free software; you can redistribute it    #
+#   and/or modify it under the terms of either :                           #
+#                                                                          #
+#    - the GNU Lesser General Public License as published by               #
+#      the Free Software Foundation, either version 3 of the License,      #
+#      or (at your option) any later version,                              #
+#    - the MIT license (MIT),                                              #
+#    - or both in dual license, as here.                                   #
+#                                                                          #
+#   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    #
+#                                                                          #
+#   This aGrUM/pyAgrum library is distributed in the hope that it will be  #
+#   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          #
+#   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or 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.                                        #
+#                                                                          #
+#   See LICENCES for more details.                                         #
+#                                                                          #
+#   SPDX-FileCopyrightText: Copyright 2005-2025                            #
+#       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 #
+#       - Christophe GONZALES(_at_AMU)                                     #
+#   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      #
+#                                                                          #
+#   Contact  : info_at_agrum_dot_org                                       #
+#   homepage : http://agrum.gitlab.io                                      #
+#   gitlab   : https://gitlab.com/agrumery/agrum                           #
+#                                                                          #
+############################################################################
+
+"""
+pyagrum.lib is a set of python tools for pyagrum.
+"""
+
+__author__ = "Pierre-Henri Wuillemin"
+__copyright__ = "(c) 2016-2024 PARIS"