Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • execution_mode is a string defining the actual OE behavior.

    • The default value is optimization mode, where the OE behaves normally.

    • In simulation mode, the OE does not try to optimize any criterion but instead just computes exposed variables and criterion states from the initial values of decision variables.

      • In practice, value finders are replaced with static variables when the system is instantiated in this mode.

      • This mode is particularly useful to compute the initial state of constraints.

    • The wtp_tuning mode is reserved for Market Simulation when using the OE as a mean to tune Willingness to Pay (WTP).

      • This mode is currently not used in production.

  • profiling is a map allowing up to four keys, one for each possible metric to profile:

    • criticality is a map containing:

      • enabled, a Boolean indicating whether or not the profiling of criticality is enabled.

      • flush_period, an integer indicating when the recording journals should be flushed.

      • sample_period, an integer indicating the sampling of the steps. E.g. 10 means the criticality is recorded every ten steps.

      • If enabled, the OE outputs a new table named Profile_Criticality containing the highest criticality value at each sampled step.

    • value_finders is a map containing:

      • enabled, a Boolean indicating whether or not the profiling of value finders is enabled.

      • flush_period, an integer indicating when the recording journals should be flushed.

      • sample_period, an integer indicating the sampling of the steps. E.g. 10 means the criticality is recorded every ten steps.

      • If enabled, the OE outputs a new table named Profile_ValueFinders containing the value, amplitude and entropy of each value finders at each sampled step.

    • memory is a map containing:

      • enabled, a Boolean indicating whether or not memory profiling is enabled.

      • gc, a Boolean indicating whether or not garbage collecting is enabled during the profiling.

      • If enabled, the OE attaches to the model a CSV file containing memory profiling data.

    • asyncProfiler is a map containing:

      • enabled, a Boolean indicating whether or not memory profiling is enabled.

      • event, a string specifying the type of event to profile. Possible values: cpu, alloc, lock, cache-misses. The default value is cpu which is to profile CPU cycles. Refer to async-profiler documentation for more information.

      • If enabled, the OE attaches to the model an HTML file containing CPU profiling data.

  • io is a map containing:

    • outputsPrefix, a string that will be used to prefix every table created by this run of the OE.

...