synthval.metrics.FCNNAccuracyMetric
===================================

.. py:class:: synthval.metrics.FCNNAccuracyMetric(test_percentage = 0.2, rng_seed = 0, network_params = synthval.configs.DEFAULT_NETWORK_PARAMS, training_params = synthval.configs.DEFAULT_TRAINING_PARAMS, testing_params = synthval.configs.DEFAULT_TESTING_PARAMS)

   Bases: :py:obj:`SimilarityMetric`


   Similarity Metric computing the Accuracy of a fully-connected neural networks trained to distinguish between the
   points belonging to the distributions real_dist and synth_dist.

   .. attribute:: test_percentage

      Percentage of the samples to use for the testing of the network, and therefore for computing the
      final metric (default: 0.2).

      :type: float, Optional

   .. attribute:: rng_seed

      Random Generator seed used for numpy utilities (default: 0).

      :type: int, Optional

   .. attribute:: network_params

      Contains the relevant parameters needed to build the network. Refer to configs.DEFAULT_NETWORK_PARAMS for
      an example (default: configs.DEFAULT_NETWORK_PARAMS).

      :type: dict, Optional

   .. attribute:: training_params

      Contains the relevant parameters needed to train the network. Refer to configs.DEFAULT_TRAINING_PARAMS for
      an example (default: configs.DEFAULT_TRAINING_PARAMS).

      :type: dict, Optional

   .. attribute:: testing_params

      Contains the relevant parameters needed to test the network. Refer to configs.DEFAULT_TESTING_PARAMS for
      an example (default: configs.DEFAULT_TESTING_PARAMS).

      :type: dict, Optional


   .. py:method:: calculate(real_dist_df, synth_dist_df)

      Compute the Accuracy of a fully-connected neural networks trained to distinguish between the
      points belonging to the distributions real_dist and synth_dist.

      :param real_dist_df: Set of samples representing distribution real_dist.
      :type real_dist_df: pandas.DataFrame
      :param synth_dist_df: Set of samples representing distribution synth_dist.
      :type synth_dist_df: pandas.DataFrame

      :returns: A numpy array containing the final accuracy computed on the test set.
      :rtype: numpy.ndarray