pymgrid.modules.GridModule
==========================

.. currentmodule:: pymgrid.modules

.. autoclass:: GridModule

   

   
   .. rubric:: Methods

   .. autosummary::
      :toctree: generated/

   
       
       
          ~GridModule.as_fixed
       
       
          ~GridModule.as_flex
       
       
          ~GridModule.as_sink
       
       
          ~GridModule.as_source
       
       
          ~GridModule.dump
       
       
          ~GridModule.dynamic_action_space
       
       
          ~GridModule.forecast
       
       
          ~GridModule.from_normalized
       
       
          ~GridModule.get_co2_cost
       
       
          ~GridModule.get_co2_production
       
       
          ~GridModule.get_cost
       
       
          ~GridModule.load
       
       
          ~GridModule.log_dict
       
       
          ~GridModule.log_frame
       
       
          ~GridModule.reset
       
       
          ~GridModule.sample_action
       
       
          ~GridModule.serializable_state_attributes
       
       
          ~GridModule.serialize
       
       
          ~GridModule.set_forecaster
       
       
          ~GridModule.state_dict
       
       
          ~GridModule.step
       
       
          ~GridModule.to_normalized
       
       
          ~GridModule.update
       
       
          ~GridModule.verbose_eq
       
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
      :toctree: generated/

   
      ~GridModule.absorption_marginal_cost
      ~GridModule.action_space
      ~GridModule.co2_per_kwh
      ~GridModule.current_obs
      ~GridModule.current_status
      ~GridModule.current_step
      ~GridModule.export_price
      ~GridModule.final_step
      ~GridModule.forecast_horizon
      ~GridModule.forecaster
      ~GridModule.forecaster_increase_uncertainty
      ~GridModule.forecaster_relative_noise
      ~GridModule.grid_status
      ~GridModule.import_price
      ~GridModule.is_sink
      ~GridModule.is_source
      ~GridModule.log
      ~GridModule.logger
      ~GridModule.logger_last
      ~GridModule.marginal_cost
      ~GridModule.max_act
      ~GridModule.max_consumption
      ~GridModule.max_obs
      ~GridModule.max_production
      ~GridModule.min_act
      ~GridModule.min_obs
      ~GridModule.min_production
      ~GridModule.module_type
      ~GridModule.observation_space
      ~GridModule.production_marginal_cost
      ~GridModule.state
      ~GridModule.state_components
      ~GridModule.time_series
      ~GridModule.weak_grid
      ~GridModule.yaml_tag