scml.scml2020.agents.moving
===========================

.. py:module:: scml.scml2020.agents.moving

.. autoapi-nested-parse::

   Implements the `DecentralizingAgent` which creates ony buy and one sell controller for each time-step and relinquishes
   control of negotiations to buy/sell the required number of items of its input/output product.



Classes
-------

.. autoapisummary::

   scml.scml2020.agents.moving.MovingRangeAgent
   scml.scml2020.agents.moving.MarketAwareMovingRangeAgent


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

.. py:class:: MovingRangeAgent(*args, price_weight=0.7, utility_threshold=0.9, time_threshold=0.9, time_horizon=0.1, min_price_margin=0.5, max_price_margin=0.5, **kwargs)

   Bases: :py:obj:`scml.scml2020.components.MovingRangeNegotiationManager`, :py:obj:`scml.scml2020.components.trading.PredictionBasedTradingStrategy`, :py:obj:`scml.scml2020.components.SupplyDrivenProductionStrategy`, :py:obj:`scml.scml2020.world.SCML2020Agent`


   My negotiation strategy

   :param price_weight: The relative importance of price in the utility calculation.
   :param utility_threshold: The fraction of maximum utility above which all offers will be accepted.
   :param time_threshold: The fraction of the negotiation time after which any valid offers will be accepted.
   :param time_range: The time-range for each controller as a fraction of the number of simulation steps

   Hooks Into:
       - `init`
       - `step`

   Remarks:
       - `Attributes` section describes the attributes that can be used to construct the component (passed to its
         `__init__` method).
       - `Provides` section describes the attributes (methods, properties, data-members) made available by this
         component directly. Note that everything provided by the bases of this components are also available to the
         agent (Check the `Bases` section above for all the bases of this component).
       - `Requires` section describes any requirements from the agent using this component. It defines a set of methods
         or properties/data-members that must exist in the agent that uses this component. These requirement are
         usually implemented as abstract methods in the component
       - `Abstract` section describes abstract methods that MUST be implemented by any descendant of this component.
       - `Hooks Into` section describes the methods this component overrides calling `super` () which allows other
         components to hook into the same method (by overriding it). Usually callbacks starting with `on_` are
         hooked into this way.
       - `Overrides` section describes the methods this component overrides without calling `super` effectively
         disallowing any other components after it in the MRO to call this method. Usually methods that do some
         action (i.e. not starting with `on_`) are overridden this way.




.. py:class:: MarketAwareMovingRangeAgent(*args, min_price_margin=0.5, max_price_margin=0.5, **kwargs)

   Bases: :py:obj:`scml.scml2020.components.prediction.MarketAwareTradePredictionStrategy`, :py:obj:`MovingRangeAgent`


   Predicts an amount based on publicly available market information. Falls
   back to fixed prediction if no information is available

   Hooks Into:
       - `internal_state`
       - `on_contracts_finalized`

   Remarks:
       - `Attributes` section describes the attributes that can be used to construct the component (passed to its
         `__init__` method).
       - `Provides` section describes the attributes (methods, properties, data-members) made available by this
         component directly. Note that everything provided by the bases of this components are also available to the
         agent (Check the `Bases` section above for all the bases of this component).
       - `Requires` section describes any requirements from the agent using this component. It defines a set of methods
         or properties/data-members that must exist in the agent that uses this component. These requirement are
         usually implemented as abstract methods in the component
       - `Abstract` section describes abstract methods that MUST be implemented by any descendant of this component.
       - `Hooks Into` section describes the methods this component overrides calling `super` () which allows other
         components to hook into the same method (by overriding it). Usually callbacks starting with `on_` are
         hooked into this way.
       - `Overrides` section describes the methods this component overrides without calling `super` effectively
         disallowing any other components after it in the MRO to call this method. Usually methods that do some
         action (i.e. not starting with `on_`) are overridden this way.