_transforms
===========

.. py:module:: _transforms

.. autoapi-nested-parse::

   The old transforms.py; it is deprecated



Attributes
----------

.. autoapisummary::

   _transforms.read_scaler
   _transforms.logger


Classes
-------

.. autoapisummary::

   _transforms.NormalizeState_Quantile
   _transforms.NormalizeState
   _transforms.NormalizeTendency
   _transforms.ToTensor


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

.. py:data:: read_scaler
   :value: None


.. py:data:: logger

.. py:class:: NormalizeState_Quantile(conf)

   Class to use the Quantile scaler functionality.


   .. py:attribute:: scaler_file


   .. py:attribute:: variables


   .. py:attribute:: surface_variables


   .. py:attribute:: levels


   .. py:attribute:: scaler_df


   .. py:attribute:: scaler_3ds


   .. py:attribute:: scaler_surfs


   .. py:attribute:: scaler_3d


   .. py:attribute:: scaler_surf


   .. py:method:: __call__(sample: credit.data.Sample, inverse: bool = False) -> credit.data.Sample

      Normalize via quantile transform.

      Normalize via provided scaler file/s.

      :param sample: batch.
      :param inverse: if true, will inverse the transform.

      :returns: transformed type.
      :rtype: torch.tensor



   .. py:method:: inverse_transform(x: torch.Tensor) -> torch.Tensor

      Inverse transform.

      Inverse transform.

      :param x: batch.

      :returns: inverse transformed x.



   .. py:method:: transform(sample: Dict[str, numpy.ndarray]) -> Dict[str, numpy.ndarray]

      Transform.

      Transform.

      :param sample: batch.

      :returns: transformed batch.



.. py:class:: NormalizeState(conf)

   Class to normalize state.


   .. py:attribute:: mean_ds


   .. py:attribute:: std_ds


   .. py:attribute:: variables


   .. py:attribute:: surface_variables


   .. py:attribute:: levels


   .. py:method:: __call__(sample: credit.data.Sample, inverse: bool = False) -> credit.data.Sample

      Normalize via quantile transform.

      Normalize via provided scaler file/s.

      :param sample: batch.
      :param inverse: if true, will inverse the transform.

      :returns: transformed type.
      :rtype: torch.tensor



   .. py:method:: transform_dataset(DS: xarray.Dataset) -> xarray.Dataset


   .. py:method:: transform_array(x: torch.Tensor) -> torch.Tensor

      Transform from unscaled to scaled values.

      Transform.

      :param x: batch.

      :returns: transformed x.



   .. py:method:: transform(sample: Dict[str, numpy.ndarray]) -> Dict[str, numpy.ndarray]

      Transform from unscaled to scaled values.

      Transform.

      :param sample: batch.

      :returns: transformed sample.



   .. py:method:: inverse_transform(x: torch.Tensor) -> torch.Tensor

      Inverse transform between tensor forms.

      Inverse transform.

      :param x: batch.

      :returns: inverse transformed x.



.. py:class:: NormalizeTendency(variables, surface_variables, base_path)

   Normalize tendency.


   .. py:attribute:: variables


   .. py:attribute:: surface_variables


   .. py:attribute:: base_path


   .. py:attribute:: mean


   .. py:attribute:: std


   .. py:method:: transform(tensor, surface_tensor)

      Transform.

      Transform input tensor/s.

      :param tensor: batch.
      :type tensor: torch tensor
      :param surface_tensor: surface batch.
      :type surface_tensor: torch tensor

      :returns: transformed torch tensors.
      :rtype: torch.Tensor



   .. py:method:: inverse_transform(tensor, surface_tensor)

      Inverse transform.

      Inverse transform input tensor/s.

      :param tensor: batch.
      :type tensor: torch tensor
      :param surface_tensor: surface batch.
      :type surface_tensor: torch tensor

      :returns: inverse transformed torch tensors.
      :rtype: torch.Tensor



.. py:class:: ToTensor(conf)

   Convert variables from xr.Datasets to Pytorch Tensors.


   .. py:attribute:: conf


   .. py:attribute:: hist_len


   .. py:attribute:: for_len


   .. py:attribute:: variables


   .. py:attribute:: surface_variables


   .. py:attribute:: allvars


   .. py:attribute:: static_variables


   .. py:method:: __call__(sample: credit.data.Sample) -> credit.data.Sample

      Convert to reshaped tensor.

      Reshape and convert to torch tensor.

      :param sample: batch.
      :type sample: interator

      :returns: reshaped torch tensor.
      :rtype: torch.tensor