ExperimentClient

class ExperimentClient(access_token, url, additional_params)[source]

Client for accessing IBM Quantum experiment services.

ExperimentClient constructor.

Parameters:
  • access_token – The session’s access token

  • url – The session’s base url

  • additional_params – additional session parameters

Methods

ExperimentClient.analysis_result_create(result)

Upload an analysis result.

ExperimentClient.analysis_result_delete(...)

Delete an analysis result.

ExperimentClient.analysis_result_get(result_id)

Retrieve an analysis result.

ExperimentClient.analysis_result_update(...)

Update an analysis result.

ExperimentClient.analysis_results(limit, marker)

Return a list of analysis results.

ExperimentClient.bulk_analysis_result_update(...)

Bulk updates analysis results.

ExperimentClient.device_components(backend_name)

Return device components for the backend.

ExperimentClient.devices()

Return the device list from the experiment DB.

ExperimentClient.experiment_delete(experiment_id)

Delete an experiment.

ExperimentClient.experiment_file_download(...)

Downloads a data file from the DB

ExperimentClient.experiment_file_upload(...)

Uploads a data file to the DB

ExperimentClient.experiment_files_get(...)

Retrieve experiment related files.

ExperimentClient.experiment_get(experiment_id)

Get a specific experiment.

ExperimentClient.experiment_plot_delete(...)

Delete an experiment plot.

ExperimentClient.experiment_plot_get(...)

Retrieve an experiment plot.

ExperimentClient.experiment_plot_update(...)

Update an experiment plot.

ExperimentClient.experiment_plot_upload(...)

Upload an experiment plot.

ExperimentClient.experiment_update(...)

Update an experiment.

ExperimentClient.experiment_upload(data)

Upload an experiment.

ExperimentClient.experiments(limit, marker, ...)

Retrieve experiments, with optional filtering.