Merge pull request #54 from BoostV/53-show-expected-minimum-in-object…

…ive-function Read plot_objective "pars" from extras
BoostV · Feb 7, 2023 · 5d7020c · 5d7020c
2 parents 109e114 + e457d63
commit 5d7020c
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/optimizerapi/openapi/specification.yml b/optimizerapi/openapi/specification.yml
@@ -121,6 +121,12 @@ components:
         extras:
           description: A plain JSON object that can contain arbitrary values
           type: object
+          properties:
+            objectivePars:
+              type: string
+              enum:
+                - result
+                - expected_minimum
         data:
           type: array
           items:

diff --git a/optimizerapi/optimizer.py b/optimizerapi/optimizer.py
@@ -184,6 +184,8 @@ def process_result(result, optimizer, dimensions, cfg, extras, data, space):
     # as "None" at the moment.
     graph_format = extras.get("graphFormat", "png")
 
+    objective_pars = extras.get("objectivePars", "result")
+
     # In the following section details that should be reported to
     # clients should go into the "resultDetails" dictionary and plots
     # go into the "plots" list (this is handled by calling the "addPlot" function)
@@ -206,7 +208,8 @@ def process_result(result, optimizer, dimensions, cfg, extras, data, space):
 
                 plot_objective(model, dimensions=dimensions,
                                usepartialdependence=False,
-                               show_confidence=True)
+                               show_confidence=True, 
+                               pars=objective_pars)
                 add_plot(plots, f"objective_{idx}")
 
             if optimizer.n_objectives == 1: