smartgrid.rewards.numeric.per_agent.over_consumption.OverConsumptionPerAgent

class smartgrid.rewards.numeric.per_agent.over_consumption.OverConsumptionPerAgent

Bases: Reward

Reward representing the overConsumption percentage of an Agent.

__init__()

Methods

__init__()
calculate(world, agent)	Compute the reward for a specific Agent at the current time step.
reset()	Reset the reward function.

Attributes

name	Uniquely identifying, human-readable name for this reward function.

calculate(world, agent)

Compute the reward for a specific Agent at the current time step.

Parameters:

• world – The World, used to get the current state and determine consequences of the agent’s action.

• agent – The Agent that is rewarded, used to access particular information about the agent (personal state) and its action.

Returns:

A reward, i.e., a single value describing how well the agent performed. The higher the reward, the better its action was. Typically, a value in [0,1] but any range can be used.

name: str

Uniquely identifying, human-readable name for this reward function.

reset()

Reset the reward function.

This function must be overridden by reward functions that use a state, so that the state is reset with the environment. By default, does nothing, as most reward functions do not use a state.