base_reward_function
====================

.. py:module:: base_reward_function


Classes
-------

.. autoapisummary::

   base_reward_function.RewardFunction


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

.. py:class:: RewardFunction(cfg, initial_state)

   Base class for reward functions in trading environments.
   @TODO pass in the profit calculated from the position step


   .. py:attribute:: cfg


   .. py:attribute:: initial_state


   .. py:method:: __repr__()


   .. py:method:: reset()

      Reset the reward function state.



   .. py:method:: compute_reward(pf, df, realized_profit)

      Compute the reward for a given action and state transition.