fix: produce the entire job result for microsoft.dft target + Job doc…

… fix (#577) * fix: return original DFT job result + doc fixes
microsoft · Feb 22, 2024 · 2f1db3d · 2f1db3d
1 parent 85babe2
commit 2f1db3d
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 5 deletions.
diff --git a/azure-quantum/azure/quantum/job/job.py b/azure-quantum/azure/quantum/job/job.py
@@ -79,7 +79,7 @@ def wait_until_completed(
         :type timeout_secs: int
         :param print_progress: Print "." to stdout to display progress
         :type print_progress: bool
-        :raises TimeoutError: If the total poll time exceeds timeout, raise
+        :raises: :class:`TimeoutError` If the total poll time exceeds timeout, raise.
         """
         self.refresh()
         poll_wait = Job._default_poll_wait
@@ -106,10 +106,12 @@ def get_results(self, timeout_secs: float = DEFAULT_TIMEOUT):
         """Get job results by downloading the results blob from the
         storage container linked via the workspace.
 
+        Raises :class:`RuntimeError` if job execution fails.
+
         :param timeout_secs: Timeout in seconds, defaults to 300
         :type timeout_secs: float
-        :raises RuntimeError: Raises RuntimeError if job execution failed
         :return: Results dictionary with histogram shots, or raw results if not a json object.
+        :rtype: Any
         """
         if self.results is not None:
             return self.results

diff --git a/azure-quantum/azure/quantum/target/microsoft/elements/dft/job.py b/azure-quantum/azure/quantum/target/microsoft/elements/dft/job.py
@@ -27,13 +27,13 @@ def get_results(self, timeout_secs: float = DEFAULT_TIMEOUT) -> Dict[str, Any]:
 
         :param timeout_secs: Timeout in seconds, defaults to 300
         :type timeout_secs: float
-        :raises RuntimeError: Raises RuntimeError if job execution failed
+        :raises: :class:`RuntimeError` Raises RuntimeError if job execution failed
         :return: Results dictionary with histogram shots, or raw results if not a json object.
         """
 
         try:
             job_results = super().get_results(timeout_secs)
-            return job_results["results"]
+            return job_results
         except JobFailedWithResultsError as e:
                 failure_results = e.get_failure_results()
                 if MicrosoftElementsDftJob._is_dft_failure_results(failure_results):

diff --git a/azure-quantum/tests/unit/test_microsoft_elements_dft.py b/azure-quantum/tests/unit/test_microsoft_elements_dft.py
@@ -27,7 +27,7 @@ def test_dft_success(self):
 
         results = job.get_results(timeout_secs=DEFAULT_TIMEOUT_SECS)
         self.assertIsNotNone(results)
-        self.assertIsNotNone(results[0]["return_result"])
+        self.assertIsNotNone(results["results"][0]["return_result"])
 
     @pytest.mark.microsoft_elements_dft
     def test_dft_failure_invalid_input(self):