:py:mod:`pycmtensor.data`
=========================

.. py:module:: pycmtensor.data

.. autoapi-nested-parse::

   PyCMTensor data module



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

.. py:class:: Data(df: pandas.DataFrame, choice: str)

   Base Data class object

   .. py:method:: x()
      :property:


   .. py:method:: y()
      :property:


   .. py:method:: all()
      :property:


   .. py:method:: split_db(split_frac=0.8)

      Split database data into train and valid sets


   .. py:method:: get_nrows() -> int

      Returns the lenth of the DataFrame object


   .. py:method:: scale_data(**kwargs)

      Scales data values by data/scale from ``kwargs:{column=scale}``


   .. py:method:: autoscale_data(except_for=[None])

      Autoscale variable values to within -10.0 < x < 10.0

      :param except_for: list of str to skip autoscaling
      :type except_for: list


   .. py:method:: info()

      Outputs information about the Data class object



.. py:class:: PandasDataFrame(df: pandas.DataFrame, choice: str)

   Class object to store Pandas DataFrames

   .. py:method:: inputs(tensors, index=None, batch_size=None, shift=None, split_type=None, k=0) -> list[pandas.DataFrame]

      Returns a list of DataFrame corresponding to the tensors input arg.


   .. py:method:: split_pandas(seed, split_frac)



.. py:class:: Variables(choice: str)

   Class object to store TensorVariables

   .. py:method:: x() -> list[aesara.tensor.TensorVariable]
      :property:

      Returns only the x ``aet.TensorVariable`` of the class


   .. py:method:: y() -> aesara.tensor.TensorVariable
      :property:

      Returns only the y ``aet.TensorVariable`` of the class


   .. py:method:: all() -> list[aesara.tensor.TensorVariable]
      :property:

      Returns all ``TensorVariable``