Hide navigation sidebar

Hide table of contents sidebar

Skip to content

Toggle site navigation sidebar

EthicalSmartGrid documentation

Toggle table of contents sidebar

EthicalSmartGrid documentation

Select a version (v: v1.2.0)

Branches (dev features)

algorithms
master
notebooks

Released versions

v2.0.0
v1.2.0
v1.1.0
v1.0.0

Introduction

The SmartGrid use-case
Usage
Visualizing results

Advanced

Custom scenario
Adding a new model
Argumentation-based reward functions

Extending the environment

Why extending
Reward functions
Agents profiles
Energy generators
Observations

API

API Reference
Toggle navigation of API Reference
- smartgrid
  Toggle navigation of smartgrid
  - smartgrid.agents
    Toggle navigation of smartgrid.agents
    - smartgrid.agents.agent
      Toggle navigation of smartgrid.agents.agent
    - smartgrid.agents.data_conversion
      Toggle navigation of smartgrid.agents.data_conversion
      - smartgrid.agents.data_conversion.DataConversion
      - smartgrid.agents.data_conversion.DataOpenEIConversion
    - smartgrid.agents.profile
      Toggle navigation of smartgrid.agents.profile
      - smartgrid.agents.profile.agent_profile
        Toggle navigation of smartgrid.agents.profile.agent_profile
        
        smartgrid.agents.profile.agent_profile.AgentProfile
      - smartgrid.agents.profile.comfort
        Toggle navigation of smartgrid.agents.profile.comfort
        
        smartgrid.agents.profile.comfort.flexible_comfort_profile
        
        smartgrid.agents.profile.comfort.neutral_comfort_profile
        
        smartgrid.agents.profile.comfort.richard_curve
        
        smartgrid.agents.profile.comfort.strict_comfort_profile
      - smartgrid.agents.profile.need
        Toggle navigation of smartgrid.agents.profile.need
        
        smartgrid.agents.profile.need.NeedProfile
      - smartgrid.agents.profile.production
        Toggle navigation of smartgrid.agents.profile.production
        
        smartgrid.agents.profile.production.ProductionProfile
  - smartgrid.environment
    Toggle navigation of smartgrid.environment
    - smartgrid.environment.SmartGrid
  - smartgrid.make_env
    Toggle navigation of smartgrid.make_env
    - smartgrid.make_env.find_profile_data
    - smartgrid.make_env.make_basic_smartgrid
  - smartgrid.observation
    Toggle navigation of smartgrid.observation
    - smartgrid.observation.global_observation
      Toggle navigation of smartgrid.observation.global_observation
      - smartgrid.observation.global_observation.GlobalObservation
    - smartgrid.observation.local_observation
      Toggle navigation of smartgrid.observation.local_observation
      - smartgrid.observation.local_observation.LocalObservation
    - smartgrid.observation.observation_manager
      Toggle navigation of smartgrid.observation.observation_manager
      - smartgrid.observation.observation_manager.ObservationManager
    - smartgrid.observation.observations
      Toggle navigation of smartgrid.observation.observations
      - smartgrid.observation.observations.Observation
  - smartgrid.rewards
    Toggle navigation of smartgrid.rewards
    - smartgrid.rewards.argumentation
      Toggle navigation of smartgrid.rewards.argumentation
      - smartgrid.rewards.argumentation.affordability
        Toggle navigation of smartgrid.rewards.argumentation.affordability
        
        smartgrid.rewards.argumentation.affordability.Affordability
      - smartgrid.rewards.argumentation.env_sustain
        Toggle navigation of smartgrid.rewards.argumentation.env_sustain
        
        smartgrid.rewards.argumentation.env_sustain.EnvironmentalSustainability
      - smartgrid.rewards.argumentation.inclusiveness
        Toggle navigation of smartgrid.rewards.argumentation.inclusiveness
        
        smartgrid.rewards.argumentation.inclusiveness.Inclusiveness
      - smartgrid.rewards.argumentation.situation
        Toggle navigation of smartgrid.rewards.argumentation.situation
        
        smartgrid.rewards.argumentation.situation.parse_situation
      - smartgrid.rewards.argumentation.supply_security
        Toggle navigation of smartgrid.rewards.argumentation.supply_security
        
        smartgrid.rewards.argumentation.supply_security.SupplySecurity
    - smartgrid.rewards.numeric
      Toggle navigation of smartgrid.rewards.numeric
      - smartgrid.rewards.numeric.differentiated
        Toggle navigation of smartgrid.rewards.numeric.differentiated
        
        smartgrid.rewards.numeric.differentiated.adaptability
        Toggle navigation of smartgrid.rewards.numeric.differentiated.adaptability
        
        smartgrid.rewards.numeric.differentiated.adaptability.AdaptabilityOne
        
        smartgrid.rewards.numeric.differentiated.adaptability.AdaptabilityThree
        
        smartgrid.rewards.numeric.differentiated.adaptability.AdaptabilityTwo
        
        smartgrid.rewards.numeric.differentiated.equity
        Toggle navigation of smartgrid.rewards.numeric.differentiated.equity
        
        smartgrid.rewards.numeric.differentiated.equity.Equity
        
        smartgrid.rewards.numeric.differentiated.multi_objective_product
        Toggle navigation of smartgrid.rewards.numeric.differentiated.multi_objective_product
        
        smartgrid.rewards.numeric.differentiated.multi_objective_product.MultiObjectiveProduct
        
        smartgrid.rewards.numeric.differentiated.multi_objective_sum
        Toggle navigation of smartgrid.rewards.numeric.differentiated.multi_objective_sum
        
        smartgrid.rewards.numeric.differentiated.multi_objective_sum.MultiObjectiveSum
        
        smartgrid.rewards.numeric.differentiated.over_consumption
        Toggle navigation of smartgrid.rewards.numeric.differentiated.over_consumption
        
        smartgrid.rewards.numeric.differentiated.over_consumption.OverConsumption
      - smartgrid.rewards.numeric.per_agent
        Toggle navigation of smartgrid.rewards.numeric.per_agent
        
        smartgrid.rewards.numeric.per_agent.adaptability
        Toggle navigation of smartgrid.rewards.numeric.per_agent.adaptability
        
        smartgrid.rewards.numeric.per_agent.adaptability.AdaptabilityOnePerAgent
        
        smartgrid.rewards.numeric.per_agent.adaptability.AdaptabilityThreePerAgent
        
        smartgrid.rewards.numeric.per_agent.adaptability.AdaptabilityTwoPerAgent
        
        smartgrid.rewards.numeric.per_agent.comfort
        Toggle navigation of smartgrid.rewards.numeric.per_agent.comfort
        
        smartgrid.rewards.numeric.per_agent.comfort.Comfort
        
        smartgrid.rewards.numeric.per_agent.equity
        Toggle navigation of smartgrid.rewards.numeric.per_agent.equity
        
        smartgrid.rewards.numeric.per_agent.equity.EquityPerAgent
        
        smartgrid.rewards.numeric.per_agent.multi_objective_sum
        Toggle navigation of smartgrid.rewards.numeric.per_agent.multi_objective_sum
        
        smartgrid.rewards.numeric.per_agent.multi_objective_sum.MultiObjectiveSumPerAgent
        
        smartgrid.rewards.numeric.per_agent.over_consumption
        Toggle navigation of smartgrid.rewards.numeric.per_agent.over_consumption
        
        smartgrid.rewards.numeric.per_agent.over_consumption.OverConsumptionPerAgent
    - smartgrid.rewards.reward
      Toggle navigation of smartgrid.rewards.reward
      - smartgrid.rewards.reward.Reward
    - smartgrid.rewards.reward_collection
      Toggle navigation of smartgrid.rewards.reward_collection
      - smartgrid.rewards.reward_collection.RewardCollection
    - smartgrid.rewards.reward_constraints
      Toggle navigation of smartgrid.rewards.reward_constraints
      - smartgrid.rewards.reward_constraints.AgentConstrainedReward
      - smartgrid.rewards.reward_constraints.TimeConstrainedReward
  - smartgrid.scenarii
    Toggle navigation of smartgrid.scenarii
  - smartgrid.util
    Toggle navigation of smartgrid.util
    - smartgrid.util.available_energy
      Toggle navigation of smartgrid.util.available_energy
    - smartgrid.util.bounded
      Toggle navigation of smartgrid.util.bounded
      - smartgrid.util.bounded.decrease_bounded
      - smartgrid.util.bounded.increase_bounded
    - smartgrid.util.equity
      Toggle navigation of smartgrid.util.equity
      - smartgrid.util.equity.hoover
    - smartgrid.util.interpolate
  - smartgrid.world
    Toggle navigation of smartgrid.world
    - smartgrid.world.World
  - smartgrid.wrappers
    Toggle navigation of smartgrid.wrappers
    - smartgrid.wrappers.reward_aggregator
      Toggle navigation of smartgrid.wrappers.reward_aggregator
- algorithms
  Toggle navigation of algorithms
  - algorithms.model
    Toggle navigation of algorithms.model
    - algorithms.model.Model
  - algorithms.naive
    Toggle navigation of algorithms.naive
    - algorithms.naive.random_model
      Toggle navigation of algorithms.naive.random_model
      - algorithms.naive.random_model.RandomModel
  - algorithms.qsom
    Toggle navigation of algorithms.qsom
    - algorithms.qsom.qsom
      Toggle navigation of algorithms.qsom.qsom
      - algorithms.qsom.qsom.QSOM
    - algorithms.qsom.qsom_agent
      Toggle navigation of algorithms.qsom.qsom_agent
      - algorithms.qsom.qsom_agent.QsomAgent
    - algorithms.qsom.som
      Toggle navigation of algorithms.qsom.som
      - algorithms.qsom.som.fast_norm
      - algorithms.qsom.som.SOM
  - algorithms.util
    Toggle navigation of algorithms.util
    - algorithms.util.action_perturbator
      Toggle navigation of algorithms.util.action_perturbator
    - algorithms.util.action_selector
      Toggle navigation of algorithms.util.action_selector

Toggle table of contents sidebar

smartgrid.rewards.numeric.per_agent.over_consumption¶

members:

Classes

OverConsumptionPerAgent()

Reward representing the overConsumption percentage of an Agent.

smartgrid.rewards.numeric.per_agent.over_consumption.OverConsumptionPerAgent

smartgrid.rewards.numeric.per_agent.multi_objective_sum.MultiObjectiveSumPerAgent

Copyright © 2023, Clément Scheirlinck & Rémy Chaput

Made with Sphinx and @pradyunsg's Furo