Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
EthicalSmartGrid documentation
EthicalSmartGrid documentation
Select a version (v: v1.0.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
  • Custom scenario
  • Adding a new model

Extending the environment

  • Why extending
  • Reward functions
  • Agents profiles
  • Energy generators
  • Observations

API

  • API Reference
    • smartgrid
      • smartgrid.agents
        • smartgrid.agents.agent
          • smartgrid.agents.agent.Action
          • smartgrid.agents.agent.Agent
          • smartgrid.agents.agent.AgentState
        • smartgrid.agents.data_conversion
          • smartgrid.agents.data_conversion.DataConversion
          • smartgrid.agents.data_conversion.DataOpenEIConversion
        • smartgrid.agents.profile
          • smartgrid.agents.profile.agent_profile
            • smartgrid.agents.profile.agent_profile.AgentProfile
          • 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
            • smartgrid.agents.profile.need.NeedProfile
          • smartgrid.agents.profile.production
            • smartgrid.agents.profile.production.ProductionProfile
      • smartgrid.environment
        • smartgrid.environment.SmartGrid
      • smartgrid.make_env
        • smartgrid.make_env.find_profile_data
        • smartgrid.make_env.make_basic_smartgrid
      • smartgrid.observation
        • smartgrid.observation.global_observation
          • smartgrid.observation.global_observation.GlobalObservation
        • smartgrid.observation.local_observation
          • smartgrid.observation.local_observation.LocalObservation
        • smartgrid.observation.observation_manager
          • smartgrid.observation.observation_manager.ObservationManager
        • smartgrid.observation.observations
          • smartgrid.observation.observations.Observation
      • smartgrid.rewards
        • smartgrid.rewards.numeric
          • smartgrid.rewards.numeric.differentiated
            • 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
              • smartgrid.rewards.numeric.differentiated.equity.Equity
            • smartgrid.rewards.numeric.differentiated.multi_objective_product
              • smartgrid.rewards.numeric.differentiated.multi_objective_product.MultiObjectiveProduct
            • smartgrid.rewards.numeric.differentiated.multi_objective_sum
              • smartgrid.rewards.numeric.differentiated.multi_objective_sum.MultiObjectiveSum
            • smartgrid.rewards.numeric.differentiated.over_consumption
              • smartgrid.rewards.numeric.differentiated.over_consumption.OverConsumption
          • smartgrid.rewards.numeric.per_agent
            • 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
              • smartgrid.rewards.numeric.per_agent.comfort.Comfort
            • smartgrid.rewards.numeric.per_agent.equity
              • smartgrid.rewards.numeric.per_agent.equity.EquityPerAgent
            • smartgrid.rewards.numeric.per_agent.multi_objective_sum
              • smartgrid.rewards.numeric.per_agent.multi_objective_sum.MultiObjectiveSumPerAgent
            • smartgrid.rewards.numeric.per_agent.over_consumption
              • smartgrid.rewards.numeric.per_agent.over_consumption.OverConsumptionPerAgent
        • smartgrid.rewards.reward
          • smartgrid.rewards.reward.Reward
        • smartgrid.rewards.reward_collection
          • smartgrid.rewards.reward_collection.RewardCollection
      • smartgrid.util
        • smartgrid.util.available_energy
          • smartgrid.util.available_energy.EnergyGenerator
          • smartgrid.util.available_energy.GenerousEnergyGenerator
          • smartgrid.util.available_energy.RandomEnergyGenerator
          • smartgrid.util.available_energy.RealisticEnergyGenerator
          • smartgrid.util.available_energy.ScarceEnergyGenerator
        • smartgrid.util.bounded
          • smartgrid.util.bounded.decrease_bounded
          • smartgrid.util.bounded.increase_bounded
        • smartgrid.util.equity
          • smartgrid.util.equity.hoover
        • smartgrid.util.interpolate
      • smartgrid.world
        • smartgrid.world.World
      • smartgrid.wrappers
        • smartgrid.wrappers.reward_aggregator
          • smartgrid.wrappers.reward_aggregator.MinRewardAggregator
          • smartgrid.wrappers.reward_aggregator.ProductRewardAggregator
          • smartgrid.wrappers.reward_aggregator.RewardAggregator
          • smartgrid.wrappers.reward_aggregator.SingleRewardAggregator
          • smartgrid.wrappers.reward_aggregator.WeightedSumRewardAggregator
    • algorithms
      • algorithms.model
        • algorithms.model.Model
      • algorithms.naive
        • algorithms.naive.random_model
          • algorithms.naive.random_model.RandomModel
      • algorithms.qsom
        • algorithms.qsom.qsom
          • algorithms.qsom.qsom.QSOM
        • algorithms.qsom.qsom_agent
          • algorithms.qsom.qsom_agent.QsomAgent
        • algorithms.qsom.som
          • algorithms.qsom.som.fast_norm
          • algorithms.qsom.som.SOM
      • algorithms.util
        • algorithms.util.action_perturbator
          • algorithms.util.action_perturbator.ActionPerturbator
          • algorithms.util.action_perturbator.EpsilonActionPerturbator
          • algorithms.util.action_perturbator.GaussianActionPerturbator
          • algorithms.util.action_perturbator.IdentityAction
          • algorithms.util.action_perturbator.MultiDimActionPerturbator
        • algorithms.util.action_selector
          • algorithms.util.action_selector.ActionSelector
          • algorithms.util.action_selector.BoltzmannActionSelector
          • algorithms.util.action_selector.EpsilonGreedyActionSelector
Back to top
View this page

smartgrid.agents¶

This module contains the Agents and their relevant classes and functions (Profiles, comforts, …).

This includes:

  • Agent
    • AgentState

    • Action

  • AgentProfile
    • NeedProfile

    • ProductionProfile

    • Comfort functions

  • DataConversion

members:

Modules

agent

This module contains the Agent class, its state (AgentState) and Action.

data_conversion

This module is used to convert raw data into Agent Profiles.

profile

Profiles are shared by Agents and contain common characteristics.

Next
smartgrid.agents.agent
Previous
smartgrid
Copyright © 2023, Clément Scheirlinck & Rémy Chaput
Made with Sphinx and @pradyunsg's Furo