sispca.data
===========

.. py:module:: sispca.data


Classes
-------

.. autoapisummary::

   sispca.data.Supervision
   sispca.data.SISPCADataset


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

.. py:class:: Supervision(target_data, target_type, target_name=None, target_kernel=None)

   Custom data class for variable used as supervision.

   :param target_data: (n_sample, n_dim_target). The target data used as supervision.
   :type target_data: 2D tensor or ndarray
   :param target_type: One of ['continuous', 'categorical', 'custom']. The type of the target data.
                       If 'custom', the target_kernel should be provided.
   :type target_type: str
   :param target_name: The name of the target data.
   :type target_name: str
   :param target_kernel: (n_sample, n_sample). Optional. The kernel matrix of the target data.
                         Once provided, the target_data will be ignored.
   :type target_kernel: 2D tensor


   .. py:attribute:: target_data


   .. py:attribute:: target_type


   .. py:attribute:: target_name
      :value: None



   .. py:attribute:: target_kernel
      :value: None



   .. py:attribute:: n_sample


   .. py:method:: _sanity_check()


   .. py:method:: _calc_kernel()

      Calculate the kernel matrix of the target data.



.. py:class:: SISPCADataset(data, target_supervision_list: List[Supervision])

   Bases: :py:obj:`torch.utils.data.Dataset`


   Custom dataset for supervised independent subspace PCA (sisPCA).

   :param data: (n_sample, n_feature). Data to run sisPCA on.
   :type data: 2D tensor
   :param target_supervision_list: List of Supervision objects.
   :type target_supervision_list: list of Supervision


   .. py:attribute:: x


   .. py:attribute:: n_sample


   .. py:attribute:: n_feature


   .. py:attribute:: target_supervision_list


   .. py:attribute:: n_target


   .. py:attribute:: target_data_list


   .. py:attribute:: target_kernel_list


   .. py:attribute:: target_name_list


   .. py:method:: __len__()


   .. py:method:: __getitem__(idx)