:py:mod:`anomed_challenge.challenge_server`
===========================================

.. py:module:: anomed_challenge.challenge_server

.. autodoc2-docstring:: anomed_challenge.challenge_server
   :parser: docstrings_parser
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`DataReconstructionPrivacyResource <anomed_challenge.challenge_server.DataReconstructionPrivacyResource>`
     - .. autodoc2-docstring:: anomed_challenge.challenge_server.DataReconstructionPrivacyResource
          :parser: docstrings_parser
          :summary:
   * - :py:obj:`DataReconstructionUtilityResource <anomed_challenge.challenge_server.DataReconstructionUtilityResource>`
     - .. autodoc2-docstring:: anomed_challenge.challenge_server.DataReconstructionUtilityResource
          :parser: docstrings_parser
          :summary:
   * - :py:obj:`DynamicNumpyDataResource <anomed_challenge.challenge_server.DynamicNumpyDataResource>`
     - .. autodoc2-docstring:: anomed_challenge.challenge_server.DynamicNumpyDataResource
          :parser: docstrings_parser
          :summary:
   * - :py:obj:`StaticJSONResource <anomed_challenge.challenge_server.StaticJSONResource>`
     - .. autodoc2-docstring:: anomed_challenge.challenge_server.StaticJSONResource
          :parser: docstrings_parser
          :summary:
   * - :py:obj:`StaticNumpyDataResource <anomed_challenge.challenge_server.StaticNumpyDataResource>`
     - .. autodoc2-docstring:: anomed_challenge.challenge_server.StaticNumpyDataResource
          :parser: docstrings_parser
          :summary:
   * - :py:obj:`UtilityResource <anomed_challenge.challenge_server.UtilityResource>`
     - .. autodoc2-docstring:: anomed_challenge.challenge_server.UtilityResource
          :parser: docstrings_parser
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`supervised_learning_MIA_challenge_server_factory <anomed_challenge.challenge_server.supervised_learning_MIA_challenge_server_factory>`
     - .. autodoc2-docstring:: anomed_challenge.challenge_server.supervised_learning_MIA_challenge_server_factory
          :parser: docstrings_parser
          :summary:
   * - :py:obj:`tabular_data_reconstruction_challenge_server_factory <anomed_challenge.challenge_server.tabular_data_reconstruction_challenge_server_factory>`
     - .. autodoc2-docstring:: anomed_challenge.challenge_server.tabular_data_reconstruction_challenge_server_factory
          :parser: docstrings_parser
          :summary:

API
~~~

.. py:class:: DataReconstructionPrivacyResource(challenge_obj: anomed_challenge.challenge.TabularDataReconstructionChallenge, evaluation_submitter: typing.Callable[[falcon.Request, dict[str, float]], None])
   :canonical: anomed_challenge.challenge_server.DataReconstructionPrivacyResource

   .. autodoc2-docstring:: anomed_challenge.challenge_server.DataReconstructionPrivacyResource
      :parser: docstrings_parser

   .. rubric:: Initialization

   .. autodoc2-docstring:: anomed_challenge.challenge_server.DataReconstructionPrivacyResource.__init__
      :parser: docstrings_parser

   .. py:method:: on_post(req: falcon.Request, resp: falcon.Response) -> None
      :canonical: anomed_challenge.challenge_server.DataReconstructionPrivacyResource.on_post

      .. autodoc2-docstring:: anomed_challenge.challenge_server.DataReconstructionPrivacyResource.on_post
         :parser: docstrings_parser

.. py:class:: DataReconstructionUtilityResource(challenge_obj: anomed_challenge.challenge.TabularDataReconstructionChallenge, evaluation_submitter: typing.Callable[[falcon.Request, dict[str, float]], None])
   :canonical: anomed_challenge.challenge_server.DataReconstructionUtilityResource

   .. autodoc2-docstring:: anomed_challenge.challenge_server.DataReconstructionUtilityResource
      :parser: docstrings_parser

   .. rubric:: Initialization

   .. autodoc2-docstring:: anomed_challenge.challenge_server.DataReconstructionUtilityResource.__init__
      :parser: docstrings_parser

   .. py:method:: on_post(req: falcon.Request, resp: falcon.Response) -> None
      :canonical: anomed_challenge.challenge_server.DataReconstructionUtilityResource.on_post

      .. autodoc2-docstring:: anomed_challenge.challenge_server.DataReconstructionUtilityResource.on_post
         :parser: docstrings_parser

.. py:class:: DynamicNumpyDataResource(individual_data_provider: typing.Callable[[falcon.Request], anomed_challenge.challenge.NumpyDataset])
   :canonical: anomed_challenge.challenge_server.DynamicNumpyDataResource

   .. autodoc2-docstring:: anomed_challenge.challenge_server.DynamicNumpyDataResource
      :parser: docstrings_parser

   .. rubric:: Initialization

   .. autodoc2-docstring:: anomed_challenge.challenge_server.DynamicNumpyDataResource.__init__
      :parser: docstrings_parser

   .. py:method:: on_get(req, resp: falcon.Response) -> None
      :canonical: anomed_challenge.challenge_server.DynamicNumpyDataResource.on_get

      .. autodoc2-docstring:: anomed_challenge.challenge_server.DynamicNumpyDataResource.on_get
         :parser: docstrings_parser

.. py:class:: StaticJSONResource(obj: typing.Any)
   :canonical: anomed_challenge.challenge_server.StaticJSONResource

   .. autodoc2-docstring:: anomed_challenge.challenge_server.StaticJSONResource
      :parser: docstrings_parser

   .. rubric:: Initialization

   .. autodoc2-docstring:: anomed_challenge.challenge_server.StaticJSONResource.__init__
      :parser: docstrings_parser

   .. py:method:: on_get(_, resp: falcon.Response)
      :canonical: anomed_challenge.challenge_server.StaticJSONResource.on_get

      .. autodoc2-docstring:: anomed_challenge.challenge_server.StaticJSONResource.on_get
         :parser: docstrings_parser

.. py:class:: StaticNumpyDataResource(data: anomed_challenge.challenge.NumpyDataset)
   :canonical: anomed_challenge.challenge_server.StaticNumpyDataResource

   .. autodoc2-docstring:: anomed_challenge.challenge_server.StaticNumpyDataResource
      :parser: docstrings_parser

   .. rubric:: Initialization

   .. autodoc2-docstring:: anomed_challenge.challenge_server.StaticNumpyDataResource.__init__
      :parser: docstrings_parser

   .. py:method:: on_get(_, resp: falcon.Response) -> None
      :canonical: anomed_challenge.challenge_server.StaticNumpyDataResource.on_get

      .. autodoc2-docstring:: anomed_challenge.challenge_server.StaticNumpyDataResource.on_get
         :parser: docstrings_parser

.. py:function:: supervised_learning_MIA_challenge_server_factory(challenge_obj: anomed_challenge.challenge.SupervisedLearningMIAChallenge) -> falcon.App
   :canonical: anomed_challenge.challenge_server.supervised_learning_MIA_challenge_server_factory

   .. autodoc2-docstring:: anomed_challenge.challenge_server.supervised_learning_MIA_challenge_server_factory
      :parser: docstrings_parser

.. py:function:: tabular_data_reconstruction_challenge_server_factory(challenge_obj: anomed_challenge.challenge.TabularDataReconstructionChallenge) -> falcon.App
   :canonical: anomed_challenge.challenge_server.tabular_data_reconstruction_challenge_server_factory

   .. autodoc2-docstring:: anomed_challenge.challenge_server.tabular_data_reconstruction_challenge_server_factory
      :parser: docstrings_parser

.. py:class:: UtilityResource(target_data_provider: typing.Callable[[falcon.Request], numpy.ndarray], evaluator: typing.Callable[[numpy.ndarray, numpy.ndarray], dict[str, float]], submitter: typing.Callable[[falcon.Request, dict[str, float]], None])
   :canonical: anomed_challenge.challenge_server.UtilityResource

   .. autodoc2-docstring:: anomed_challenge.challenge_server.UtilityResource
      :parser: docstrings_parser

   .. rubric:: Initialization

   .. autodoc2-docstring:: anomed_challenge.challenge_server.UtilityResource.__init__
      :parser: docstrings_parser

   .. py:method:: on_post(req: falcon.Request, resp: falcon.Response) -> None
      :canonical: anomed_challenge.challenge_server.UtilityResource.on_post

      .. autodoc2-docstring:: anomed_challenge.challenge_server.UtilityResource.on_post
         :parser: docstrings_parser