:py:mod:`anomed_anonymizer.anonymizer_server`
=============================================

.. py:module:: anomed_anonymizer.anonymizer_server

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

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

Classes
~~~~~~~

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

   * - :py:obj:`InferenceResource <anomed_anonymizer.anonymizer_server.InferenceResource>`
     - .. autodoc2-docstring:: anomed_anonymizer.anonymizer_server.InferenceResource
          :parser: docstrings_parser
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`supervised_learning_anonymizer_server_factory <anomed_anonymizer.anonymizer_server.supervised_learning_anonymizer_server_factory>`
     - .. autodoc2-docstring:: anomed_anonymizer.anonymizer_server.supervised_learning_anonymizer_server_factory
          :parser: docstrings_parser
          :summary:
   * - :py:obj:`tabular_data_anonymizer_server_factory <anomed_anonymizer.anonymizer_server.tabular_data_anonymizer_server_factory>`
     - .. autodoc2-docstring:: anomed_anonymizer.anonymizer_server.tabular_data_anonymizer_server_factory
          :parser: docstrings_parser
          :summary:
   * - :py:obj:`validate_anonymizer_input_or_raise <anomed_anonymizer.anonymizer_server.validate_anonymizer_input_or_raise>`
     - .. autodoc2-docstring:: anomed_anonymizer.anonymizer_server.validate_anonymizer_input_or_raise
          :parser: docstrings_parser
          :summary:

API
~~~

.. py:class:: InferenceResource(anonymizer_identifier: str, model_filepath: str | pathlib.Path, model_loader: typing.Callable[[str | pathlib.Path], anomed_anonymizer.anonymizer.SupervisedLearningAnonymizer], default_batch_size: int, tuning_data_url: str, validation_data_url: str, utility_evaluation_url: str, download_timeout: float, upload_timeout: float)
   :canonical: anomed_anonymizer.anonymizer_server.InferenceResource

   .. autodoc2-docstring:: anomed_anonymizer.anonymizer_server.InferenceResource
      :parser: docstrings_parser

   .. rubric:: Initialization

   .. autodoc2-docstring:: anomed_anonymizer.anonymizer_server.InferenceResource.__init__
      :parser: docstrings_parser

   .. py:method:: on_post_predict(req: falcon.Request, resp: falcon.Response) -> None
      :canonical: anomed_anonymizer.anonymizer_server.InferenceResource.on_post_predict

      .. autodoc2-docstring:: anomed_anonymizer.anonymizer_server.InferenceResource.on_post_predict
         :parser: docstrings_parser

   .. py:method:: on_post_evaluate(req: falcon.Request, resp: falcon.Response) -> None
      :canonical: anomed_anonymizer.anonymizer_server.InferenceResource.on_post_evaluate

      .. autodoc2-docstring:: anomed_anonymizer.anonymizer_server.InferenceResource.on_post_evaluate
         :parser: docstrings_parser

.. py:function:: supervised_learning_anonymizer_server_factory(anonymizer_identifier: str, anonymizer_obj: anomed_anonymizer.anonymizer.SupervisedLearningAnonymizer, model_filepath: str | pathlib.Path, default_batch_size: int, training_data_url: str, tuning_data_url: str, validation_data_url: str, utility_evaluation_url: str, model_loader: typing.Callable[[str | pathlib.Path], anomed_anonymizer.anonymizer.SupervisedLearningAnonymizer], download_timeout: float = 10.0, upload_timeout: float = 10.0) -> falcon.App
   :canonical: anomed_anonymizer.anonymizer_server.supervised_learning_anonymizer_server_factory

   .. autodoc2-docstring:: anomed_anonymizer.anonymizer_server.supervised_learning_anonymizer_server_factory
      :parser: docstrings_parser

.. py:function:: tabular_data_anonymizer_server_factory(anonymizer_identifier: str, anonymizer_obj: anomed_anonymizer.anonymizer.TabularDataAnonymizer, output_dir: str | pathlib.Path, leaky_data_url: str, utility_evaluation_url: str, download_timeout: float = 10.0, upload_timeout: float = 10.0) -> falcon.App
   :canonical: anomed_anonymizer.anonymizer_server.tabular_data_anonymizer_server_factory

   .. autodoc2-docstring:: anomed_anonymizer.anonymizer_server.tabular_data_anonymizer_server_factory
      :parser: docstrings_parser

.. py:function:: validate_anonymizer_input_or_raise(feature_array: numpy.ndarray, anonymizer: anomed_anonymizer.anonymizer_server.validate_anonymizer_input_or_raise.anonymizer, error_status: str | int | None = falcon.HTTP_INTERNAL_SERVER_ERROR, error_message: str | None = None) -> None
   :canonical: anomed_anonymizer.anonymizer_server.validate_anonymizer_input_or_raise

   .. autodoc2-docstring:: anomed_anonymizer.anonymizer_server.validate_anonymizer_input_or_raise
      :parser: docstrings_parser