:py:mod:`kosmos.ml.datasets.banknote_dataset`
=============================================

.. py:module:: kosmos.ml.datasets.banknote_dataset







Classes
-------

.. py:class:: BanknoteDataset(*, min_max_scaler: bool = True)

   Bases: :py:class:`kosmos.ml.datasets.dataset.SLDataset`

   Banknote authentication dataset for binary classification.

   .. admonition:: Notes

      - Number of instances: 1372
      - Number of features: 4 numeric
      - Classes: 2 (slightly imbalanced; 762 real, 610 forged)

   .. admonition:: References

      - UCI Machine Learning Repository — Banknote authentication dataset: https://archive.ics.uci.edu/dataset/267/banknote+authentication

   Initialize the dataset.

   :param min_max_scaler: Whether to apply min-max scaling to the features.
   :type min_max_scaler: bool




   |

   .. rubric:: Properties

   .. py:property:: class_names

      0 = Genuine, 1 = Forged.

      :type: Return human-readable class labels

   .. py:property:: input_dimension

      Number of feature columns.

   .. py:property:: output_dim

      Number of distinct classes.