leaf_engine.adapt.context
=========================

.. py:module:: leaf_engine.adapt.context


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/leaf_engine/adapt/context/adapt_contexts/index
   /autoapi/leaf_engine/adapt/context/context/index


Classes
-------

.. autoapisummary::

   leaf_engine.adapt.context.AdaptActionContext
   leaf_engine.adapt.context.AdaptConsolidatedNetworkActionContext
   leaf_engine.adapt.context.AdaptDataContext
   leaf_engine.adapt.context.AdaptETLContext
   leaf_engine.adapt.context.AdaptExplorerContext
   leaf_engine.adapt.context.AdaptNetworkContext
   leaf_engine.adapt.context.AdaptObservationContext
   leaf_engine.adapt.context.AdaptSyntheticRateContext
   leaf_engine.adapt.context.Context
   leaf_engine.adapt.context.DataSource


Package Contents
----------------

.. py:class:: AdaptActionContext(int_rt: Callable[[], pandas.DataFrame], int_tri: Callable[[], pandas.DataFrame], leaf_rt: Callable[[], pandas.DataFrame], ext_rt: Callable[[], pandas.DataFrame], ext_tri: Callable[[], pandas.DataFrame], leaf_tri: Callable[[], pandas.DataFrame], int_cm: Callable[[], pandas.DataFrame], ext_cm: Callable[[], pandas.DataFrame], leaf_cm: Callable[[], pandas.DataFrame], shorty: Callable[[], pandas.DataFrame], leaf_shorty: Callable[[], pandas.DataFrame], flex_daily_price: Callable[[], pandas.DataFrame], flex_daily_performance: Callable[[], pandas.DataFrame], flex_weekly_price: Callable[[], pandas.DataFrame], flex_uncommitted_price: Callable[[], pandas.DataFrame])

   Bases: :py:obj:`leaf_engine.adapt.context.context.Context`


.. py:class:: AdaptConsolidatedNetworkActionContext(actions: Callable[[], pandas.DataFrame])

   Bases: :py:obj:`leaf_engine.adapt.context.context.Context`


.. py:class:: AdaptDataContext(equip_class_ships: Callable[[], pandas.DataFrame], markets: Callable[[], pandas.DataFrame], lanes: Callable[[], pandas.DataFrame], db_lanes: Callable[[], pandas.DataFrame], lane_equip_class_annual_volume: Callable[[], pandas.DataFrame], lane_equip_class_recent_rpm: Callable[[], pandas.DataFrame], company_id: int, company_name: str, batch_date: str, equipment_class: str, dat_fuel: float, db_key: str, run_type: dict, incl_record_types: list[str], leaf_company_ids: list[int])

   Bases: :py:obj:`leaf_engine.adapt.context.context.Context`


.. py:class:: AdaptETLContext(ships: Callable[[], pandas.DataFrame], markets: Callable[[], pandas.DataFrame], db_lanes: Callable[[], pandas.DataFrame], company_id: int, batch_date: str, company_name: str, equipment_class: str, db_key: str, minimum_lane_miles: int, oa_daily_params: Dict, oa_dow_params: Dict, oa_weekly_params: Dict, leaf_company_ids: list[int])

   Bases: :py:obj:`leaf_engine.adapt.context.context.Context`


.. py:class:: AdaptExplorerContext(lane_summary: Callable[[], pandas.DataFrame], lane_daily_volume: Callable[[], pandas.DataFrame], lane_detail_volume: Callable[[], pandas.DataFrame], lane_daily_spend: Callable[[], pandas.DataFrame], lane_scac_daily_volume: Callable[[], pandas.DataFrame], lane_scac_spend: Callable[[], pandas.DataFrame], lane_weekly_scac_spend: Callable[[], pandas.DataFrame], lane_quick_ref: Callable[[], pandas.DataFrame])

   Bases: :py:obj:`leaf_engine.adapt.context.context.Context`


.. py:class:: AdaptNetworkContext(int_rt: Callable[[], pandas.DataFrame], ext_rt: Callable[[], pandas.DataFrame], leaf_rt: Callable[[], pandas.DataFrame], int_tri: Callable[[], pandas.DataFrame], ext_tri: Callable[[], pandas.DataFrame], leaf_tri: Callable[[], pandas.DataFrame], int_cm: Callable[[], pandas.DataFrame], ext_cm: Callable[[], pandas.DataFrame], leaf_cm: Callable[[], pandas.DataFrame], shorty: Callable[[], pandas.DataFrame], leaf_shorty: Callable[[], pandas.DataFrame])

   Bases: :py:obj:`leaf_engine.adapt.context.context.Context`


.. py:class:: AdaptObservationContext(contract_rate_spread: Callable[[], pandas.DataFrame], spot_exposure: Callable[[], pandas.DataFrame], market_rate_variance: Callable[[], pandas.DataFrame], carrier_churn: Callable[[], pandas.DataFrame], daily_pattern: Callable[[], pandas.DataFrame], weekly_pattern: Callable[[], pandas.DataFrame], should_be_flex: Callable[[], pandas.DataFrame])

   Bases: :py:obj:`leaf_engine.adapt.context.context.Context`


.. py:class:: AdaptSyntheticRateContext(lane_rates: Callable[[], pandas.DataFrame], market_rates: Callable[[], pandas.DataFrame], dat_fuel: float)

   Bases: :py:obj:`leaf_engine.adapt.context.context.Context`


.. py:class:: Context(sources: Dict[str, DataSource], params: dict)

   .. py:method:: __getstate__()


   .. py:method:: __setstate__(state)


   .. py:method:: from_pkl(filename)
      :staticmethod:



   .. py:method:: load(load_sources=None, validate=True)


   .. py:method:: sources() -> Dict[str, str]


   .. py:method:: to_pkl(filename)


   .. py:method:: validate(validate_sources=None)


   .. py:attribute:: _sources


   .. py:attribute:: data
      :type:  Dict[str, pandas.DataFrame]


   .. py:attribute:: params


   .. py:attribute:: pickled
      :value: False



.. py:class:: DataSource(schema: pandera.DataFrameSchema, source: Callable[[], pandas.DataFrame])

   .. py:method:: load(validate=True) -> pandas.DataFrame


   .. py:method:: validate()


   .. py:attribute:: _data


   .. py:attribute:: schema


   .. py:attribute:: source