unreal.LocalDirectionalVelocityReward
¶
- class unreal.LocalDirectionalVelocityReward(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
LearningAgentsReward
A reward for maximizing velocity along a given local axis.
C++ Source:
Plugin: LearningAgents
Module: LearningAgentsTraining
File: LearningAgentsRewards.h
Editor Properties: (see get_editor_property/set_editor_property)
agent_trainer
(LearningAgentsTrainer): [Read-Only] Reference to the Trainer this reward is associated with.
- classmethod add_local_directional_velocity_reward(agent_trainer, name='None', weight=1.000000, scale=200.000000, axis=[1.000000, 0.000000, 0.000000]) LocalDirectionalVelocityReward ¶
Adds a new directional velocity reward to the given trainer. Call during ULearningAgentsTrainer::SetupRewards event.
- Parameters:
agent_trainer (LearningAgentsTrainer) – The trainer to add this reward to.
name (Name) – The name of this new reward. Used for debugging.
weight (float) – Multiplier for this reward when being summed up for the total reward.
scale (float) – Used to normalize the data for the reward.
axis (Vector) – The local direction we want to maximize velocity in.
- Returns:
The newly created reward.
- Return type: