Skip to content
This repository was archived by the owner on Jul 28, 2023. It is now read-only.

Experiment follow up #1019

Merged
merged 2 commits into from
Jul 28, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions qiskit/providers/ibmq/api/clients/experiment.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ def experiments(
exclude_mine: Optional[bool] = False,
mine_only: Optional[bool] = False,
sort_by: Optional[str] = None
) -> Dict:
) -> str:
"""Retrieve experiments, with optional filtering.

Args:
Expand Down Expand Up @@ -94,7 +94,7 @@ def experiments(
sort_by=sort_by)
return resp

def experiment_get(self, experiment_id: str) -> Dict:
def experiment_get(self, experiment_id: str) -> str:
"""Get a specific experiment.

Args:
Expand Down Expand Up @@ -228,7 +228,7 @@ def analysis_results(
verified: Optional[bool] = None,
tags: Optional[List[str]] = None,
sort_by: Optional[str] = None
) -> Dict:
) -> str:
"""Return a list of analysis results.

Args:
Expand Down Expand Up @@ -294,7 +294,7 @@ def analysis_result_delete(self, result_id: str) -> Dict:
"""
return self.base_api.analysis_result(result_id).delete()

def analysis_result_get(self, result_id: str) -> Dict:
def analysis_result_get(self, result_id: str) -> str:
"""Retrieve an analysis result.

Args:
Expand Down
6 changes: 3 additions & 3 deletions qiskit/providers/ibmq/api/rest/analysis_result.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,11 @@ def delete(self) -> Dict:
url = self.get_url('self')
return self.session.delete(url).json()

def get(self) -> Dict:
def get(self) -> str:
"""Retrieve the analysis result.

Returns:
JSON response.
Server response.
"""
url = self.get_url('self')
return self.session.get(url).json()
return self.session.get(url).text
6 changes: 3 additions & 3 deletions qiskit/providers/ibmq/api/rest/experiment.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,14 +39,14 @@ def __init__(self, session: RetrySession, experiment_uuid: str, url_prefix: str
"""
super().__init__(session, '{}/experiments/{}'.format(url_prefix, experiment_uuid))

def retrieve(self) -> Dict:
def retrieve(self) -> str:
"""Retrieve the specific experiment.

Returns:
JSON response.
Experiment data.
"""
url = self.get_url('self')
return self.session.get(url).json()
return self.session.get(url).text

def update(self, experiment: Dict) -> Dict:
"""Update the experiment.
Expand Down
14 changes: 7 additions & 7 deletions qiskit/providers/ibmq/api/rest/root.py
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ def experiments(
exclude_mine: Optional[bool] = False,
mine_only: Optional[bool] = False,
sort_by: Optional[str] = None
) -> Dict:
) -> str:
"""Return experiment data.

Args:
Expand All @@ -184,7 +184,7 @@ def experiments(
sort_by: Sorting order.

Returns:
JSON response.
Response text.
"""
url = self.get_url('experiments')
params = {} # type: Dict[str, Any]
Expand Down Expand Up @@ -218,8 +218,8 @@ def experiments(
params['owner'] = 'me'
if sort_by:
params['sort'] = sort_by
params['include_plot_names'] = "true"
return self.session.get(url, params=params).json()

return self.session.get(url, params=params).text

def experiment_devices(self) -> Dict:
"""Return experiment devices.
Expand Down Expand Up @@ -256,7 +256,7 @@ def analysis_results(
verified: Optional[bool] = None,
tags: Optional[List[str]] = None,
sort_by: Optional[str] = None
) -> Dict:
) -> str:
"""Return all analysis results.

Args:
Expand All @@ -272,7 +272,7 @@ def analysis_results(
sort_by: Indicates how the output should be sorted.

Returns:
JSON response.
Server response.
"""
url = self.get_url('analysis_results')
params = {} # type: Dict[str, Any]
Expand All @@ -296,7 +296,7 @@ def analysis_results(
params['tags'] = tags
if sort_by:
params['sort'] = sort_by
return self.session.get(url, params=params).json()
return self.session.get(url, params=params).text

def analysis_result_upload(self, result: Dict) -> Dict:
"""Upload an analysis result.
Expand Down
6 changes: 5 additions & 1 deletion qiskit/providers/ibmq/experiment/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@

Modules related to IBM Quantum experiment service.

.. note::

This service is not available to all accounts.

You can use the experiment service to query, upload, and retrieve
experiments, experiment figures, and analysis results. For example::

Expand All @@ -31,7 +35,7 @@

This service is intended to be used in conjunction with the ``qiskit-experiments``
package, which allows you to create different types of experiments (for example,
:class:`~qiskit_experiments.characterization.T1Experiment`).
:class:`qiskit_experiments.library.characterization.T1`).


Classes
Expand Down
Loading