Analyzer

class ioh.iohcpp.logger.Analyzer(self, triggers: collections.abc.Sequence[ioh.iohcpp.logger.trigger.Trigger] = [<ioh.iohcpp.logger.trigger.OnDeltaImprovement object at 0x7f56eedf2b30>], additional_properties: collections.abc.Sequence[ioh.iohcpp.logger.property.AbstractProperty] = [], root: str | os.PathLike = PosixPath('/home/runner/work/IOHexperimenter/IOHexperimenter/doc/python'), folder_name: str = 'ioh_data', algorithm_name: str = 'algorithm_name', algorithm_info: str = 'algorithm_info', store_positions: bool = False)

Bases: AbstractLogger

A logger which stores all tracked properties to a file.

Parameters:
  • triggers (list[Trigger]) – List of triggers, i.e. when to trigger logging

  • additional_properties (list[Property]) – The list of additional properties to keep track of (additional to the default properties for this logger type)

  • root (str = "./") – The path to which to write the files

  • folder_name (str = "./") – The name of the folder to which to write the files

  • algorithm_name (str = "algorithm_name") – Optional name parameter for the algorithm to be added to the info files

  • algorithm_info (str = "algorithm_info") – Optional info parameter for the algorithm to be added to the info files

  • store_positions (bool = false) – Boolean value which indicates whether to store the x-positions in the file

Attributes Summary

output_directory

(self) -> str

problem

Reference to the currently attached problem

Methods Summary

add_experiment_attribute(self, arg0, arg1, /)

add_run_attribute(-> None)

add_run_attributes(self, arg0, arg1, /)

add_trigger(self, arg, /)

Add a trigger to the logger

attach_problem(self, problem)

attach a problem (MetaData) to a logger

call(self, arg, /)

Performs logging behaviour

close(self)

reset(self)

Reset the state of the logger

set_experiment_attributes(self, arg, /)

set_run_attribute(self, arg0, arg1, /)

set_run_attributes(self, arg, /)

watch(-> None -> None)

Attributes Documentation

output_directory

(self) -> str

problem

Reference to the currently attached problem

Methods Documentation

add_experiment_attribute(self, arg0: str, arg1: str, /) → None
add_run_attribute(self, arg0: str, arg1: float, /) → None
add_run_attribute(self, arg0: object, arg1: str, /) → None
add_run_attributes(self, arg0: object, arg1: collections.abc.Sequence[str], /) → None
add_trigger(self, arg: ioh.iohcpp.logger.trigger.Trigger, /) → None

Add a trigger to the logger

attach_problem(self, problem: ioh.iohcpp.MetaData) → None

attach a problem (MetaData) to a logger

call(self, arg: ioh.iohcpp.LogInfo, /) → None

Performs logging behaviour

close(self) → None
reset(self) → None

Reset the state of the logger

set_experiment_attributes(self, arg: collections.abc.Mapping[str, str], /) → None
set_run_attribute(self, arg0: str, arg1: float, /) → None
set_run_attributes(self, arg: collections.abc.Mapping[str, float], /) → None
watch(self, arg: ioh.iohcpp.logger.property.AbstractProperty, /) → None
watch(self, arg0: object, arg1: str, /) → None
watch(self, arg0: object, arg1: collections.abc.Sequence[str], /) → None