:py:mod:`anomed_anonymizer.anonymizer`
======================================

.. py:module:: anomed_anonymizer.anonymizer

.. autodoc2-docstring:: anomed_anonymizer.anonymizer
   :parser: docstrings_parser
   :allowtitles:

Module Contents
---------------

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`PersistingTabularDataAnonymizer <anomed_anonymizer.anonymizer.PersistingTabularDataAnonymizer>`
     - .. autodoc2-docstring:: anomed_anonymizer.anonymizer.PersistingTabularDataAnonymizer
          :parser: docstrings_parser
          :summary:
   * - :py:obj:`SupervisedLearningAnonymizer <anomed_anonymizer.anonymizer.SupervisedLearningAnonymizer>`
     - .. autodoc2-docstring:: anomed_anonymizer.anonymizer.SupervisedLearningAnonymizer
          :parser: docstrings_parser
          :summary:
   * - :py:obj:`TabularDataAnonymizer <anomed_anonymizer.anonymizer.TabularDataAnonymizer>`
     - .. autodoc2-docstring:: anomed_anonymizer.anonymizer.TabularDataAnonymizer
          :parser: docstrings_parser
          :summary:
   * - :py:obj:`TFKerasWrapper <anomed_anonymizer.anonymizer.TFKerasWrapper>`
     - .. autodoc2-docstring:: anomed_anonymizer.anonymizer.TFKerasWrapper
          :parser: docstrings_parser
          :summary:
   * - :py:obj:`WrappedAnonymizer <anomed_anonymizer.anonymizer.WrappedAnonymizer>`
     - .. autodoc2-docstring:: anomed_anonymizer.anonymizer.WrappedAnonymizer
          :parser: docstrings_parser
          :summary:

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`batch_views <anomed_anonymizer.anonymizer.batch_views>`
     - .. autodoc2-docstring:: anomed_anonymizer.anonymizer.batch_views
          :parser: docstrings_parser
          :summary:
   * - :py:obj:`pickle_anonymizer <anomed_anonymizer.anonymizer.pickle_anonymizer>`
     - .. autodoc2-docstring:: anomed_anonymizer.anonymizer.pickle_anonymizer
          :parser: docstrings_parser
          :summary:
   * - :py:obj:`unpickle_anonymizer <anomed_anonymizer.anonymizer.unpickle_anonymizer>`
     - .. autodoc2-docstring:: anomed_anonymizer.anonymizer.unpickle_anonymizer
          :parser: docstrings_parser
          :summary:

API
~~~

.. py:function:: batch_views(array: numpy.ndarray, batch_size: int | None) -> list[numpy.ndarray]
   :canonical: anomed_anonymizer.anonymizer.batch_views

   .. autodoc2-docstring:: anomed_anonymizer.anonymizer.batch_views
      :parser: docstrings_parser

.. py:class:: PersistingTabularDataAnonymizer(tabular_data_anonymizer: anomed_anonymizer.anonymizer.TabularDataAnonymizer, output_dir: str | pathlib.Path)
   :canonical: anomed_anonymizer.anonymizer.PersistingTabularDataAnonymizer

   .. autodoc2-docstring:: anomed_anonymizer.anonymizer.PersistingTabularDataAnonymizer
      :parser: docstrings_parser

   .. rubric:: Initialization

   .. autodoc2-docstring:: anomed_anonymizer.anonymizer.PersistingTabularDataAnonymizer.__init__
      :parser: docstrings_parser

   .. py:method:: anonymize(leaky_data: pandas.DataFrame) -> None
      :canonical: anomed_anonymizer.anonymizer.PersistingTabularDataAnonymizer.anonymize

      .. autodoc2-docstring:: anomed_anonymizer.anonymizer.PersistingTabularDataAnonymizer.anonymize
         :parser: docstrings_parser

   .. py:method:: get_anon_data() -> pandas.DataFrame
      :canonical: anomed_anonymizer.anonymizer.PersistingTabularDataAnonymizer.get_anon_data

      .. autodoc2-docstring:: anomed_anonymizer.anonymizer.PersistingTabularDataAnonymizer.get_anon_data
         :parser: docstrings_parser

   .. py:method:: get_anon_scheme() -> anomed_challenge.AnonymizationScheme
      :canonical: anomed_anonymizer.anonymizer.PersistingTabularDataAnonymizer.get_anon_scheme

      .. autodoc2-docstring:: anomed_anonymizer.anonymizer.PersistingTabularDataAnonymizer.get_anon_scheme
         :parser: docstrings_parser

.. py:function:: pickle_anonymizer(anonymizer: typing.Any, filepath: str | pathlib.Path) -> None
   :canonical: anomed_anonymizer.anonymizer.pickle_anonymizer

   .. autodoc2-docstring:: anomed_anonymizer.anonymizer.pickle_anonymizer
      :parser: docstrings_parser

.. py:class:: SupervisedLearningAnonymizer
   :canonical: anomed_anonymizer.anonymizer.SupervisedLearningAnonymizer

   Bases: :py:obj:`abc.ABC`

   .. autodoc2-docstring:: anomed_anonymizer.anonymizer.SupervisedLearningAnonymizer
      :parser: docstrings_parser

   .. py:method:: fit(X: numpy.ndarray, y: numpy.ndarray) -> None
      :canonical: anomed_anonymizer.anonymizer.SupervisedLearningAnonymizer.fit
      :abstractmethod:

      .. autodoc2-docstring:: anomed_anonymizer.anonymizer.SupervisedLearningAnonymizer.fit
         :parser: docstrings_parser

   .. py:method:: predict(X: numpy.ndarray, batch_size: int | None = None) -> numpy.ndarray
      :canonical: anomed_anonymizer.anonymizer.SupervisedLearningAnonymizer.predict
      :abstractmethod:

      .. autodoc2-docstring:: anomed_anonymizer.anonymizer.SupervisedLearningAnonymizer.predict
         :parser: docstrings_parser

   .. py:method:: save(filepath: str | pathlib.Path) -> None
      :canonical: anomed_anonymizer.anonymizer.SupervisedLearningAnonymizer.save
      :abstractmethod:

      .. autodoc2-docstring:: anomed_anonymizer.anonymizer.SupervisedLearningAnonymizer.save
         :parser: docstrings_parser

   .. py:method:: validate_input(feature_array: numpy.ndarray) -> None
      :canonical: anomed_anonymizer.anonymizer.SupervisedLearningAnonymizer.validate_input
      :abstractmethod:

      .. autodoc2-docstring:: anomed_anonymizer.anonymizer.SupervisedLearningAnonymizer.validate_input
         :parser: docstrings_parser

.. py:class:: TabularDataAnonymizer
   :canonical: anomed_anonymizer.anonymizer.TabularDataAnonymizer

   Bases: :py:obj:`abc.ABC`

   .. autodoc2-docstring:: anomed_anonymizer.anonymizer.TabularDataAnonymizer
      :parser: docstrings_parser

   .. py:method:: anonymize(leaky_data: pandas.DataFrame) -> tuple[pandas.DataFrame, anomed_challenge.AnonymizationScheme]
      :canonical: anomed_anonymizer.anonymizer.TabularDataAnonymizer.anonymize
      :abstractmethod:

      .. autodoc2-docstring:: anomed_anonymizer.anonymizer.TabularDataAnonymizer.anonymize
         :parser: docstrings_parser

.. py:class:: TFKerasWrapper(tfkeras_model: typing.Any, feature_array_validator: typing.Callable[[numpy.ndarray], None], **kwargs)
   :canonical: anomed_anonymizer.anonymizer.TFKerasWrapper

   Bases: :py:obj:`anomed_anonymizer.anonymizer.SupervisedLearningAnonymizer`

   .. autodoc2-docstring:: anomed_anonymizer.anonymizer.TFKerasWrapper
      :parser: docstrings_parser

   .. rubric:: Initialization

   .. autodoc2-docstring:: anomed_anonymizer.anonymizer.TFKerasWrapper.__init__
      :parser: docstrings_parser

   .. py:method:: fit(X: numpy.ndarray, y: numpy.ndarray) -> None
      :canonical: anomed_anonymizer.anonymizer.TFKerasWrapper.fit

   .. py:method:: predict(X: numpy.ndarray, batch_size: int | None = None) -> numpy.ndarray
      :canonical: anomed_anonymizer.anonymizer.TFKerasWrapper.predict

   .. py:method:: save(filepath: str | pathlib.Path) -> None
      :canonical: anomed_anonymizer.anonymizer.TFKerasWrapper.save

   .. py:method:: validate_input(feature_array: numpy.ndarray) -> None
      :canonical: anomed_anonymizer.anonymizer.TFKerasWrapper.validate_input

.. py:function:: unpickle_anonymizer(filepath: str | pathlib.Path) -> typing.Any
   :canonical: anomed_anonymizer.anonymizer.unpickle_anonymizer

   .. autodoc2-docstring:: anomed_anonymizer.anonymizer.unpickle_anonymizer
      :parser: docstrings_parser

.. py:class:: WrappedAnonymizer(anonymizer, serializer: typing.Callable[[typing.Any, str | pathlib.Path], None] | None = None, feature_array_validator: typing.Callable[[numpy.ndarray], None] | None = None)
   :canonical: anomed_anonymizer.anonymizer.WrappedAnonymizer

   Bases: :py:obj:`anomed_anonymizer.anonymizer.SupervisedLearningAnonymizer`

   .. autodoc2-docstring:: anomed_anonymizer.anonymizer.WrappedAnonymizer
      :parser: docstrings_parser

   .. rubric:: Initialization

   .. autodoc2-docstring:: anomed_anonymizer.anonymizer.WrappedAnonymizer.__init__
      :parser: docstrings_parser

   .. py:method:: fit(X: numpy.ndarray, y: numpy.ndarray)
      :canonical: anomed_anonymizer.anonymizer.WrappedAnonymizer.fit

   .. py:method:: predict(X: numpy.ndarray, batch_size: int | None = None) -> numpy.ndarray
      :canonical: anomed_anonymizer.anonymizer.WrappedAnonymizer.predict

      .. autodoc2-docstring:: anomed_anonymizer.anonymizer.WrappedAnonymizer.predict
         :parser: docstrings_parser

   .. py:method:: save(filepath: str | pathlib.Path)
      :canonical: anomed_anonymizer.anonymizer.WrappedAnonymizer.save

   .. py:method:: validate_input(feature_array: numpy.ndarray) -> None
      :canonical: anomed_anonymizer.anonymizer.WrappedAnonymizer.validate_input