DRLRewardReporter.C

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html
 
#ifdef MOOSE_LIBTORCH_ENABLED
 
#include "DRLRewardReporter.h"
 
registerMooseObject("StochasticToolsApp", DRLRewardReporter);
 
InputParameters
DRLRewardReporter::validParams()
{
  InputParameters params = GeneralReporter::validParams();
  params += SurrogateModelInterface::validParams();
 
  params.addClassDescription("Reporter containing the reward values of a DRL controller trainer.");
  params.addRequiredParam<UserObjectName>(
      "drl_trainer_name", "The name of the DRL controller trainer which computes the rewards.");
 
  return params;
}
 
DRLRewardReporter::DRLRewardReporter(const InputParameters & parameters)
  : GeneralReporter(parameters),
    SurrogateModelInterface(this),
    _average_reward(declareValueByName<Real>("average_reward", REPORTER_MODE_ROOT)),
    _std_reward(declareValueByName<Real>("std_reward", REPORTER_MODE_ROOT)),
    _sample_average_reward(
        declareValueByName<std::vector<Real>>("sample_average_reward", REPORTER_MODE_ROOT)),
    _sample_std_reward(
        declareValueByName<std::vector<Real>>("sample_std_reward", REPORTER_MODE_ROOT)),
    _trainer(getSurrogateTrainer<LibtorchDRLControlTrainer>("drl_trainer_name"))
{
}
 
void
DRLRewardReporter::execute()
{
  _average_reward = _trainer.averageEpisodeReward();
  _std_reward = _trainer.stdEpisodeReward();
  _sample_average_reward = _trainer.sampleAverageEpsiodeRewards();
  _sample_std_reward = _trainer.sampleStdEpsiodeRewards();
}
 
#endif