Skip to content

Commit 0e0edcf

Browse files
authored
Correct names in docs (#174)
1 parent 9afe044 commit 0e0edcf

File tree

3 files changed

+16
-17
lines changed

3 files changed

+16
-17
lines changed

qiskit_braket_provider/providers/braket_backend.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,14 +61,14 @@ class BraketLocalBackend(BraketBackend):
6161
"""BraketLocalBackend."""
6262

6363
def __init__(self, name: str = "default", **fields):
64-
"""BraketLocalBackend for local execution of circuits.
64+
"""BraketLocalBackend for executing circuits locally.
6565
6666
Example:
67-
>>> device = LocalSimulator() #Local State Vector Simulator
68-
>>> device = LocalSimulator("default") #Local State Vector Simulator
69-
>>> device = LocalSimulator(name="default") #Local State Vector Simulator
70-
>>> device = LocalSimulator(name="braket_sv") #Local State Vector Simulator
71-
>>> device = LocalSimulator(name="braket_dm") #Local Density Matrix Simulator
67+
>>> device = LocalSimulator() #Local State Vector Simulator
68+
>>> device = LocalSimulator("default") #Local State Vector Simulator
69+
>>> device = LocalSimulator(name="default") #Local State Vector Simulator
70+
>>> device = LocalSimulator(name="braket_sv") #Local State Vector Simulator
71+
>>> device = LocalSimulator(name="braket_dm") #Local Density Matrix Simulator
7272
7373
Args:
7474
name: name of backend
@@ -183,7 +183,7 @@ def __init__( # pylint: disable=too-many-arguments
183183
device: Optional[AwsDevice] = None,
184184
**fields,
185185
):
186-
"""BraketAwsBackend for execution circuits against AWS Braket devices.
186+
"""BraketAwsBackend for executing circuits on Amazon Braket devices.
187187
188188
Example:
189189
>>> provider = BraketProvider()

qiskit_braket_provider/providers/braket_provider.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,11 @@ class BraketProvider(ProviderV1):
1818
>>> provider = BraketProvider()
1919
>>> backends = provider.backends()
2020
>>> backends
21-
[BraketBackend[Aspen-10],
22-
BraketBackend[Aspen-11],
23-
BraketBackend[Aspen-8],
24-
BraketBackend[Aspen-9],
25-
BraketBackend[Aspen-M-1],
26-
BraketBackend[IonQ Device],
21+
[BraketBackend[Aria 1],
22+
BraketBackend[Aria 2],
23+
BraketBackend[Aspen-M-3],
24+
BraketBackend[Forte 1],
25+
BraketBackend[Harmony],
2726
BraketBackend[Lucy],
2827
BraketBackend[SV1],
2928
BraketBackend[TN1],

qiskit_braket_provider/providers/braket_quantum_task.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ def retry_if_result_none(result):
1717
return result is None
1818

1919

20-
def _get_result_from_aws_tasks(
20+
def _get_result_from_tasks(
2121
tasks: Union[List[LocalQuantumTask], List[AwsQuantumTask]],
2222
) -> Optional[List[ExperimentResult]]:
2323
"""Returns experiment results of AWS tasks.
@@ -78,7 +78,7 @@ def _get_result_from_aws_tasks(
7878

7979

8080
class BraketQuantumTask(JobV1):
81-
"""BraketTask."""
81+
"""BraketQuantumTask."""
8282

8383
def __init__(
8484
self,
@@ -87,7 +87,7 @@ def __init__(
8787
tasks: Union[List[LocalQuantumTask], List[AwsQuantumTask]],
8888
**metadata: Optional[dict],
8989
):
90-
"""BraketTask for execution of circuits on Amazon Braket or locally.
90+
"""BraketQuantumTask for execution of circuits on Amazon Braket or locally.
9191
9292
Args:
9393
task_id: Semicolon-separated IDs of the underlying tasks
@@ -159,7 +159,7 @@ def task_id(self) -> str:
159159
return self._task_id
160160

161161
def result(self) -> Result:
162-
experiment_results = _get_result_from_aws_tasks(tasks=self._tasks)
162+
experiment_results = _get_result_from_tasks(tasks=self._tasks)
163163
status = self.status(use_cached_value=True)
164164

165165
return Result(

0 commit comments

Comments
 (0)