caikit.core.augmentors.base
===========================

.. py:module:: caikit.core.augmentors.base


Attributes
----------

.. autoapisummary::

   caikit.core.augmentors.base.log
   caikit.core.augmentors.base.error


Classes
-------

.. autoapisummary::

   caikit.core.augmentors.base.AugmentorBase


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

.. py:data:: log

.. py:data:: error

.. py:class:: AugmentorBase(random_seed, produces_none=False)

   .. py:attribute:: produces_none
      :value: False



   .. py:method:: augment(inp_obj)

      Take an object in, give an object back. Calls ._augment in the subclass.

      Args:
          inp_obj (str | caikit.core.data_model.DataBase): Object to be
              augmented.
      Returns:
          str | caikit.core.data_model.DataBase: Augmented object of same type
              as input inp_obj.



   .. py:method:: reset()

      Reset random number generation for the current augmentor. Note that this currently
      assumes the augmentor is using the builtin random generator leveraged by Python; if
      you end up using something else, you may want to override this or restructure this
      base class to allow resetting of random states based on seed type.