Visualization

NEXTorch offers a variety of visualization functions in nextorch.plotting module. The plots are rendered using matplotlib as a backend. It is an active area of development for NEXTorch.

We provide two forms of the visualization functions depending on their inputs format:

1. X or Y matrics or

2. an Experiment object (functions that end with _exp).

Parity Plots

parity	Plot parity plot comparing the ground true objective function values against predicted model mean
parity_exp	Plot parity plot comparing the ground true objective function values against predicted model mean Using Experiment object
parity_with_ci	Plot parity plot comparing the ground true objective function values against predicted model mean with predicted confidence interval as error bars
parity_with_ci_exp	Plot parity plot comparing the ground true objective function values against predicted model mean with predicted confidence interval as error bars Using Experiment object

Discovery Plots

opt_per_trial	Discovery plot show the optimum value performance versus the trial number i.e. the index of training data.
opt_per_trial_exp	Discovery plot show the optimum value performance versus the trial number i.e. the index of training data Using the experiment object.

Functions in 1-dimension Parameter Spaces

acq_func_1d	Plot 1-dimensional acquision function at the given dimension defined by x_index
acq_func_1d_exp	Plot 1-dimensional acquision function at the given dimension defined by x_index Using Experiment object
response_1d	Plot response values at the given dimension defined by x_index Input X variables are in a unit scale and Input Y variables are in a real scale
response_1d_exp	Plot reponse valus at the given dimension defined by x_index using Experiment object

Functions in 2-dimensional Parameter Spaces

sampling_2d	Plot sampling plan(s) in 2 dimensional space X must be 2 dimensional
sampling_2d_exp	Plot sampling plan(s) in 2 dimensional space X must be 2 dimensional Using the experiment object
response_heatmap	Show a heat map for the response in a real scale
response_heatmap_exp	Show a heat map for the response in a real scale Using the experiment object :param Exp: Experiment object :type Exp: Experiment :param X_new: The next data point, i.e the infill points, by default None :type X_new: Optional[MatrixLike2d], optional :param Y_real_range: Ranges of the response, [lb, rb] to show on the plot, by default None :type Y_real_range: Optional[ArrayLike1d], optional :param log_flag: flag to plot in a log scale :type log_flag: Optional[bool], optional :param x_indices: indices of two x variables, by default [0, 1] :type x_indices: Optional[List[int]], optional :param fixed_values: fixed values in other dimensions, in a unit scale, by default [] :type fixed_values: Optional[Union[ArrayLike1d, float]], optional :param fixed_values_real: fixed values in other dimensions, in a real scale, by default [] :type fixed_values_real: Optional[Union[ArrayLike1d, float]], optional :param baseline: the choice of baseline, must be left, right or center :type baseline: Optional[str], optional :param mesh_size: mesh size, by default 41 :type mesh_size: Optional[int], optional :param show_samples: if true show the sample points by default True :type show_samples: Optional[bool], optional :param save_fig: if true save the plot by default False :type save_fig: Optional[bool], optional
objective_heatmap	Show a 3-dimensional response surface in a real scale Using the experiment object
objective_heatmap_exp	Show a heat map for objective function in a real scale Using the experiment object :param Exp: Experiment object :type Exp: Experiment :param X_new: The next data point, i.e the infill points, by default None :type X_new: Optional[MatrixLike2d], optional :param Y_real_range: Ranges of the response, [lb, rb] to show on the plot, by default None :type Y_real_range: Optional[ArrayLike1d], optional :param log_flag: flag to plot in a log scale :type log_flag: Optional[bool], optional :param x_indices: indices of two x variables, by default [0, 1] :type x_indices: Optional[List[int]], optional :param fixed_values: fixed values in other dimensions, in a unit scale, by default [] :type fixed_values: Optional[Union[ArrayLike1d, float]], optional :param fixed_values_real: fixed values in other dimensions, in a real scale, by default [] :type fixed_values_real: Optional[Union[ArrayLike1d, float]], optional :param baseline: the choice of baseline, must be left, right or center :type baseline: Optional[str], optional :param mesh_size: mesh size, by default 41 :type mesh_size: Optional[int], optional :param show_samples: if true show the sample points by default True :type show_samples: Optional[bool], optional :param save_fig: if true save the plot by default False :type save_fig: Optional[bool], optional
response_heatmap_err_exp	Show a heat map for percentage error (objective - response)/objective in a real scale Using the experiment object :param Exp: Experiment object :type Exp: Experiment :param X_new: The next data point, i.e the infill points, by default None :type X_new: Optional[MatrixLike2d], optional :param Y_real_range: Ranges of the response, [lb, rb] to show on the plot, by default None :type Y_real_range: Optional[ArrayLike1d], optional :param log_flag: flag to plot in a log scale :type log_flag: Optional[bool], optional :param x_indices: indices of two x variables, by default [0, 1] :type x_indices: Optional[List[int]], optional :param fixed_values: fixed values in other dimensions, in a unit scale, by default [] :type fixed_values: Optional[Union[ArrayLike1d, float]], optional :param fixed_values_real: fixed values in other dimensions, in a real scale, by default [] :type fixed_values_real: Optional[Union[ArrayLike1d, float]], optional :param baseline: the choice of baseline, must be left, right or center :type baseline: Optional[str], optional :param mesh_size: mesh size, by default 41 :type mesh_size: Optional[int], optional :param save_fig: if true save the plot by default False :type save_fig: Optional[bool], optional
response_surface	Plot a response surface in 3-dimensional space
response_surface_exp	Show a 3-dimensional response surface in a real scale Using the experiment object
objective_surface	Show a 3-dimensional response surface in a real scale Using the experiment object
objective_surface_exp	Show a 3-dimensional response surface in a real scale Using the experiment object

Functions in 3-dimensional Parameter Spaces

sampling_3d	Plot sampling plan(s) in 3 dimensional space X must be 3 dimensional
sampling_3d_exp	Plot sampling plan(s) in 3 dimensional space X must be 3 dimensional Using the experiment object
response_scatter_exp	Plot a response surface in 3-dimensional space

Pareto Front

pareto_front	Plot parity plot comparing the ground true objective function values against predicted model mean
pareto_front_exp	Plot parity plot comparing the ground true objective function values against predicted model mean Using MOOExperiment object