From 732d8a4731872ef08eefedcce1409485b0f10d0c Mon Sep 17 00:00:00 2001 From: Milan Viricel Date: Thu, 21 Nov 2024 11:27:21 +0100 Subject: [PATCH] few doc update --- README.md | 6 +++--- pasqal_cloud/__init__.py | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ca9b438..1e2a48b 100644 --- a/README.md +++ b/README.md @@ -202,7 +202,7 @@ sdk.get_batches(filters=BatchFilters(device_type=EmulatorType.EMU_TN)) sdk.get_batches(filters=BatchFilters(status=BatchStatus.DONE, project_id="project_id")) # Get two batches using two ids -sdk.get_batches(filters=BatchFilters(id=["job_id_1", "job_id_2"])) +sdk.get_batches(filters=BatchFilters(id=["batch_id_1", "batch_id_2"])) # Get the first 100 batches with HIGH priority from a specific project sdk.get_batches(filters=BatchFilters(queue_priority=QueuePriority.HIGH)) @@ -315,7 +315,7 @@ sdk.cancel_batches(batch_ids=[...]) ### Cancel a list of jobs -It is possible to cancel a selection of jobs with the `cancel_jobs` method, using the JobFilters class. +It is possible to cancel a selection of jobs with the `cancel_jobs` method, using the CancelJobFilters class. Here are few examples of how to use it: @@ -326,7 +326,7 @@ from pasqal_cloud import CancelJobFilters # Cancel two specific jobs sdk.cancel_jobs(batch_id="batch_id", filters=CancelJobFilters(id=["job_id_1", "job_id_2"])) -# Cancel jobs created in a given period from a specific batch +# Cancel jobs created in a given period of time sdk.cancel_jobs(batch_id="batch_id", filters=CancelJobFilters(start_date=datetime(...), end_date=datetime(...))) ``` diff --git a/pasqal_cloud/__init__.py b/pasqal_cloud/__init__.py index dbc13ba..7418be2 100644 --- a/pasqal_cloud/__init__.py +++ b/pasqal_cloud/__init__.py @@ -369,7 +369,7 @@ def cancel_batch(self, id: str) -> Batch: def cancel_batches(self, batch_ids: List[str]) -> BatchCancellationResponse: """ - Cancel a group of batches matching the filters. + Cancel a group of batches by their ids. Args: batch_ids: batch ids to cancel.