IBMExperimentService.figure

IBMExperimentService.figure(experiment_id, figure_name, file_name=None)

Retrieve an existing figure.

Parameters:

• experiment_id (str) – Experiment ID.

• figure_name (str) – Name of the figure.

• file_name (Optional[str]) – Name of the local file to save the figure to. If None, the content of the figure is returned instead.

Return type:

Union[int, bytes]

Returns:

The size of the figure if file_name is specified. Otherwise the content of the figure in bytes.

Raises:

• IBMExperimentEntryNotFound – If the figure does not exist.

• IBMApiError – If the request to the server failed.