AutoTuner.h

Go to the documentation of this file.

 
#pragma once
 
#include <cstddef>
#include <memory>
#include <set>
#include <tuple>
 
#include "autopas/options/TuningMetricOption.h"
#include "autopas/tuning/Configuration.h"
#include "autopas/tuning/searchSpace/EvidenceCollection.h"
#include "autopas/tuning/tuningStrategy/LiveInfo.h"
#include "autopas/tuning/tuningStrategy/TuningStrategyInterface.h"
#include "autopas/tuning/utils/AutoTunerInfo.h"
#include "autopas/utils/EnergySensor.h"
#include "autopas/utils/Timer.h"
#include "autopas/utils/logging/TuningDataLogger.h"
#include "autopas/utils/logging/TuningResultLogger.h"
 
namespace autopas {
 
class AutoTuner {
 public:
  using TuningStrategiesListType = std::vector<std::unique_ptr<TuningStrategyInterface>>;
  using SearchSpaceType = std::set<Configuration>;
 
  AutoTuner(TuningStrategiesListType &tuningStrategies, const SearchSpaceType &searchSpace,
            const AutoTunerInfo &autoTunerInfo, unsigned int rebuildFrequency, const std::string &outputSuffix);
 
  AutoTuner &operator=(AutoTuner &&other) noexcept;
 
  void forceRetune();
 
  const TuningMetricOption &getTuningMetric() const;
 
  void receiveLiveInfo(const LiveInfo &liveInfo);
 
  bool isStartOfTuningPhase() const;
 
  bool tuningPhaseAboutToBegin() const;
 
  [[nodiscard]] bool needsLiveInfo() const;
 
  void bumpIterationCounters(bool needToWait = false);
 
  bool willRebuildNeighborLists() const;
 
  [[nodiscard]] const Configuration &getCurrentConfig() const;
 
  [[nodiscard]] std::tuple<Configuration, bool> getNextConfig();
 
  [[nodiscard]] std::tuple<Configuration, bool> rejectConfig(const Configuration &rejectedConfig, bool indefinitely);
 
  bool searchSpaceIsTrivial() const;
 
  bool searchSpaceIsEmpty() const;
 
  void logTuningResult(bool tuningIteration, long tuningTime) const;
 
  bool initEnergy();
 
  bool resetEnergy();
 
  std::tuple<double, double, double, long> sampleEnergy();
 
  void addMeasurement(long sample, bool neighborListRebuilt);
 
  void addDomainSimilarityStatistics(double pdBinDensityStdDev, double pdBinMaxDensity);
 
  const std::vector<Configuration> &getConfigQueue() const;
 
  const std::vector<std::unique_ptr<TuningStrategyInterface>> &getTuningStrategies() const;
 
  bool inTuningPhase() const;
 
  bool inFirstTuningIteration() const;
 
  bool inLastTuningIteration() const;
 
  const EvidenceCollection &getEvidenceCollection() const;
 
  bool canMeasureEnergy() const;
 
  void setRebuildFrequency(double rebuildFrequency);
 
  void checkEarlyStoppingCondition();
 
 private:
  size_t getCurrentNumSamples() const;
 
  [[nodiscard]] long estimateRuntimeFromSamples() const;
 
  bool tuneConfiguration();
 
  SelectorStrategyOption _selectorStrategy;
 
  std::vector<std::unique_ptr<TuningStrategyInterface>> _tuningStrategies;
 
  size_t _iteration{0};
 
  size_t _tuningPhase{0};
 
  size_t _tuningInterval;
 
  TuningMetricOption _tuningMetric;
 
  bool _useLOESSSmoothening;
 
  bool _energyMeasurementPossible;
 
  double _rebuildFrequency;
 
  size_t _maxSamples;
 
  double _earlyStoppingFactor;
 
  bool _needsDomainSimilarityStatistics;
 
  bool _needsLiveInfo;
 
  std::vector<double> _pdBinDensityStdDevOfLastTenIterations{};
 
  std::vector<double> _pdBinMaxDensityOfLastTenIterations{};
 
  std::vector<long> _samplesNotRebuildingNeighborLists;
 
  std::vector<long> _samplesRebuildingNeighborLists{};
 
  EvidenceCollection _evidenceCollection{};
 
  SearchSpaceType _searchSpace;
 
  std::vector<Configuration> _configQueue;
 
  TuningResultLogger _tuningResultLogger;
 
  TuningDataLogger _tuningDataLogger;
 
  utils::EnergySensor _energySensor;
 
  bool _isTuning{false};
 
  bool _endOfTuningPhase{false};
 
  bool _forceRetune{false};
 
  bool _earlyStoppingOfResampling{false};
 
  size_t _iterationBaseline{0};
};
}  // namespace autopas