..
   This file is part of

   Culebra is free software: you can redistribute it and/or modify it under the
   terms of the GNU General Public License as published by the Free Software
   Foundation, either version 3 of the License, or (at your option) any later
   version.

   Culebra is distributed in the hope that it will be useful, but WITHOUT ANY
   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
   FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
   details.

   You should have received a copy of the GNU General Public License along with
   Culebra. If not, see <http://www.gnu.org/licenses/>.

   This work is supported by projects PGC2018-098813-B-C31 and
   PID2022-137461NB-C31, both funded by the Spanish "Ministerio de Ciencia,
   Innovación y Universidades" and by the European Regional Development Fund
   (ERDF).

:py:class:`culebra.fitness_function.dataset_score.KappaIndex` class
===================================================================

.. autoclass:: culebra.fitness_function.dataset_score.KappaIndex

Class attributes
----------------
.. class:: culebra.fitness_function.dataset_score.KappaIndex.Fitness

    Handles the values returned by the
    :py:meth:`~culebra.fitness_function.dataset_score.KappaIndex.evaluate` method
    within a :py:class:`~culebra.abc.Solution`.

    This class must be implemented within all the
    :py:class:`~culebra.fitness_function.dataset_score.KappaIndex`
    subclasses, as a subclass of the :py:class:`~culebra.abc.Fitness` class,
    to define its three class attributes (
    :py:attr:`~culebra.abc.Fitness.weights`,
    :py:attr:`~culebra.abc.Fitness.names`, and
    :py:attr:`~culebra.abc.Fitness.thresholds`) according to the fitness
    function.

Class methods
-------------
.. automethod:: culebra.fitness_function.dataset_score.KappaIndex.load_pickle
.. automethod:: culebra.fitness_function.dataset_score.KappaIndex.set_fitness_thresholds
.. automethod:: culebra.fitness_function.dataset_score.KappaIndex.get_fitness_objective_threshold
.. automethod:: culebra.fitness_function.dataset_score.KappaIndex.set_fitness_objective_threshold

Properties
----------
.. autoproperty:: culebra.fitness_function.dataset_score.KappaIndex.is_noisy
.. autoproperty:: culebra.fitness_function.dataset_score.KappaIndex.num_obj
.. autoproperty:: culebra.fitness_function.dataset_score.KappaIndex.num_nodes
.. autoproperty:: culebra.fitness_function.dataset_score.KappaIndex.training_data
.. autoproperty:: culebra.fitness_function.dataset_score.KappaIndex.test_data
.. autoproperty:: culebra.fitness_function.dataset_score.KappaIndex.test_prop
.. autoproperty:: culebra.fitness_function.dataset_score.KappaIndex.cv_folds

Private properties
------------------
.. autoproperty:: culebra.fitness_function.dataset_score.KappaIndex._worst_score

Methods
-------
.. automethod:: culebra.fitness_function.dataset_score.KappaIndex.save_pickle
.. automethod:: culebra.fitness_function.dataset_score.KappaIndex.heuristic
.. automethod:: culebra.fitness_function.dataset_score.KappaIndex.evaluate

Private methods
---------------
.. automethod:: culebra.fitness_function.dataset_score.KappaIndex._score
.. automethod:: culebra.fitness_function.dataset_score.KappaIndex._final_training_test_data
.. automethod:: culebra.fitness_function.dataset_score.KappaIndex._evaluate_train_test
.. automethod:: culebra.fitness_function.dataset_score.KappaIndex._evaluate_mccv
.. automethod:: culebra.fitness_function.dataset_score.KappaIndex._evaluate_kfcv