AutoPas  3.0.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
autopas::PredictionLogger Class Reference

Helper to log prediction data of PredictiveTuning to a csv file for easier analysis. More...

#include <PredictionLogger.h>

Public Member Functions

 PredictionLogger (const std::string &outputSuffix="")
 Constructor initializes the logger and sets the output file name.
 
 ~PredictionLogger ()
 Destructor drops the logger from the spd registry.
 
void logAllPredictions (const std::unordered_map< Configuration, long, ConfigHash > &predictions, long predictionErrorValue, size_t tuningPhaseCounter) const
 Print all predictions of the given set of configurations to the logger.
 

Detailed Description

Helper to log prediction data of PredictiveTuning to a csv file for easier analysis.

It uses an asynchronous spd logger to write a csv file named "AutoPas_predictions_<dateStamp>.csv".

By default logging the data is disabled. It can be enabled by setting the cmake variable AUTOPAS_LOG_PREDICTIONS to ON.

Constructor & Destructor Documentation

◆ PredictionLogger()

autopas::PredictionLogger::PredictionLogger ( const std::string &  outputSuffix = "")
explicit

Constructor initializes the logger and sets the output file name.

Parameters
outputSuffixSuffix for all output files produced by this class.

Member Function Documentation

◆ logAllPredictions()

void autopas::PredictionLogger::logAllPredictions ( const std::unordered_map< Configuration, long, ConfigHash > &  predictions,
long  predictionErrorValue,
size_t  tuningPhaseCounter 
) const

Print all predictions of the given set of configurations to the logger.

Parameters
predictions
predictionErrorValue
tuningPhaseCounter

The documentation for this class was generated from the following files: