logitorch.datasets.te.control_dataset
=====================================

.. py:module:: logitorch.datasets.te.control_dataset


Attributes
----------

.. autoapisummary::

   logitorch.datasets.te.control_dataset.CONTROL_DATASET
   logitorch.datasets.te.control_dataset.CONTROL_DATASET_FOLDER
   logitorch.datasets.te.control_dataset.CONTROL_DATASET_ZIP_URL
   logitorch.datasets.te.control_dataset.CONTROL_ID_TO_LABEL
   logitorch.datasets.te.control_dataset.CONTROL_LABEL_TO_ID


Classes
-------

.. autoapisummary::

   logitorch.datasets.te.control_dataset.ControlDataset


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

.. py:class:: ControlDataset(split_set: str)

   Bases: :py:obj:`logitorch.datasets.base.AbstractTEDataset`


   Helper class that provides a standard way to create an ABC using
   inheritance.

   The function takes in a string as an argument and returns None.

   The function first checks if the string is in the list of split sets. If it is not, it raises an
   error.

   If the string is in the list of split sets, the function checks if the control dataset folder
   exists. If it does not, it downloads the dataset.

   The function then sets the split set to the string that was passed in as an argument.

   The function then sets the dataset path to the control dataset folder and the split set.

   The function then reads the dataset and sets the premises, hypotheses, and labels to the read
   dataset.

   If there is an error, the function prints the error message.

   :param split_set: str
   :type split_set: str


.. py:data:: CONTROL_DATASET
   :value: 'control_dataset'


.. py:data:: CONTROL_DATASET_FOLDER
   :value: '/logitorch_datasets/control_dataset'


.. py:data:: CONTROL_DATASET_ZIP_URL
   :value: 'https://www.dropbox.com/s/rmcqituydxacuhv/control_dataset.zip?dl=1'


.. py:data:: CONTROL_ID_TO_LABEL

.. py:data:: CONTROL_LABEL_TO_ID