cyrxnopt_analysis package

Subpackages

• cyrxnopt_analysis.alerts namespace
  • Submodules
  • cyrxnopt_analysis.alerts.Alert module
    • Alert
      • Alert.process()
      • Alert.throw
      • Alert.triggered
  • cyrxnopt_analysis.alerts.OverBudget module
    • OverBudget
      • OverBudget.budget
      • OverBudget.errors
      • OverBudget.process()
• cyrxnopt_analysis.apps namespace
  • Submodules
  • cyrxnopt_analysis.apps.main module
    • main()
    • parse_args()
• cyrxnopt_analysis.metrics namespace
  • Submodules
  • cyrxnopt_analysis.metrics.Average module
    • Average
      • Average.average_value
      • Average.calculate()
      • Average.total_cycles
      • Average.total_value
  • cyrxnopt_analysis.metrics.Clearance module
    • Clearance
      • Clearance.calculate()
      • Clearance.clearance_rate
      • Clearance.fail_count
      • Clearance.failed_results
      • Clearance.success_count
      • Clearance.successful_results
  • cyrxnopt_analysis.metrics.FeatureVariance module
    • FeatureVariance
      • FeatureVariance.calculate()
      • FeatureVariance.clearance_rate
      • FeatureVariance.fail_count
      • FeatureVariance.failed_results
      • FeatureVariance.success_count
      • FeatureVariance.successful_results
  • cyrxnopt_analysis.metrics.Metric module
    • Metric
      • Metric.calculate()
      • Metric.result
  • cyrxnopt_analysis.metrics.SolveTime module
    • SolveTime
      • SolveTime.calculate()
      • SolveTime.solve_time
      • SolveTime.solve_time_CI95
      • SolveTime.solve_time_std
      • SolveTime.total_cycles
      • SolveTime.total_iterations
  • cyrxnopt_analysis.metrics.StdDev module
    • StdDev
      • StdDev.calculate()
      • StdDev.sample_set
      • StdDev.stddev
      • StdDev.total_cycles
• cyrxnopt_analysis.transforms namespace
  • Submodules
  • cyrxnopt_analysis.transforms.GetFunctionName module
    • GetFunctionName
      • GetFunctionName.map()
  • cyrxnopt_analysis.transforms.Transform module
    • Transform
      • Transform.map()
• cyrxnopt_analysis.utilities namespace
  • Submodules
  • cyrxnopt_analysis.utilities.get_files module
    • get_files()
  • cyrxnopt_analysis.utilities.optima_table module

Submodules

cyrxnopt_analysis.AMLROResultsStrategy module

class cyrxnopt_analysis.AMLROResultsStrategy.AMLROResultsStrategy

Bases: ReadResultsStrategy

analyze_results(result_file: str) → OptimizerResult

Analyzes results from the AMLRO optimizer.

Parameters:

result_file (str) – File to read the results from. This must be formatted as a JSON file.

Returns:

Aggregated results from the optimization.

Return type:

Results

cyrxnopt_analysis.Analyzer module

class cyrxnopt_analysis.Analyzer.Analyzer(read_strategy: ReadResultsStrategy)

Bases: object

analyze_directory(results_directory: str, file_pattern: str = '*', recursive: bool = False) → List[OptimizerResult]

Analyzes all files in the given directory that match the provided regex pattern.

The results files must all be in the same format to be read correctly. If results files are in a different format, incorrect results may be collected or the program may crash. The algorithm used to analyze the file is determined by the value of read_strategy provided when the Analyzer was created.

Parameters:

• results_directory (str) – Full path to the results directory with results files to analyze.

• file_pattern (str) – Regex pattern that result files must match, defaults to r”*” for all files.

• recursive (bool, optional) – Whether to find files recursively in subdirectories (True) or not (False). Defaults to “False”.

Returns:

Results object containing the results of the optimization.

Return type:

Results

analyze_results(results_file: str) → OptimizerResult

Analyzes the given file, accumulating the results for an optimization algorithm.

The algorithm used to analyze the file is determined by the value of read_strategy provided when the Analyzer was created.

Parameters:

results_file (str) – Full path to the results file to analyze.

Returns:

Results object containing the results of the optimization.

Return type:

Results

cyrxnopt_analysis.EDBOpResultsStrategy module

class cyrxnopt_analysis.EDBOpResultsStrategy.EDBOpResultsStrategy

Bases: ReadResultsStrategy

analyze_results(result_file: str) → OptimizerResult

Analyzes results from the EDBOP optimizer.

Parameters:

result_file (str) – File to read the results from. This must be formatted as a JSON file.

Returns:

Aggregated results from the optimization.

Return type:

Results

cyrxnopt_analysis.NMSimplexResultsStrategy module

class cyrxnopt_analysis.NMSimplexResultsStrategy.NMSimplexResultsStrategy

Bases: ReadResultsStrategy

analyze_results(result_file: str) → OptimizerResult

Analyzes results from the Nelder-Mead optimizer.

Parameters:

result_file (str) – File to read the results from. This must be formatted as a JSON file.

Returns:

Aggregated results from the optimization.

Return type:

Results

cyrxnopt_analysis.OptimizerResult module

class cyrxnopt_analysis.OptimizerResult.OptimizerResult

Bases: dict

property best_coords

property best_iter

property best_value

property filename: str

property message

property raw_results

property total_iter

cyrxnopt_analysis.RandomResultsStrategy module

class cyrxnopt_analysis.RandomResultsStrategy.RandomResultsStrategy

Bases: ReadResultsStrategy

analyze_results(result_file: str) → OptimizerResult

Analyzes results from the Random sampling optimizer.

Parameters:

result_file (str) – File to read the results from. This must be formatted as a JSON file.

Returns:

Aggregated results from the optimization.

Return type:

Results

cyrxnopt_analysis.ReadResultsStrategy module

class cyrxnopt_analysis.ReadResultsStrategy.ReadResultsStrategy

Bases: ABC

analyze_results(result_file: str)

cyrxnopt_analysis.SQSnobFitResultsStrategy module

class cyrxnopt_analysis.SQSnobFitResultsStrategy.SQSnobFitResultsStrategy

Bases: ReadResultsStrategy

analyze_results(result_file: str) → OptimizerResult

Analyzes results from the SQSnobFit optimizer.

Parameters:

result_file (str) – File to read the results from. This must be formatted as a JSON file.

Returns:

Aggregated results from the optimization.

Return type:

Results

Module contents