emu-mps 2.4.1__py3-none-any.whl → 2.4.2__py3-none-any.whl

emu_mps/__init__.py

@@ -36,4 +36,4 @@ __all__ = [
     "EntanglementEntropy",
 ]
 
-__version__ = "2.4.1"
+__version__ = "2.4.2"

emu_mps/algebra.py

@@ -49,7 +49,7 @@ def add_factors(
 
 
 def scale_factors(
-    factors: list[torch.Tensor], scalar: complex, *, which: int
+    factors: list[torch.Tensor], scalar: complex | torch.Tensor, *, which: int
 ) -> list[torch.Tensor]:
     """
     Returns a new list of factors where the tensor at the given index is scaled by `scalar`.

emu_mps/mpo.py

@@ -173,10 +173,10 @@ class MPO(Operator[complex, torch.Tensor, MPS]):
                 "gg": torch.tensor([[1.0, 0.0], [0.0, 0.0]], dtype=torch.complex128).view(
                     1, 2, 2, 1
                 ),
-                "gr": torch.tensor([[0.0, 0.0], [1.0, 0.0]], dtype=torch.complex128).view(
+                "rg": torch.tensor([[0.0, 0.0], [1.0, 0.0]], dtype=torch.complex128).view(
                     1, 2, 2, 1
                 ),
-                "rg": torch.tensor([[0.0, 1.0], [0.0, 0.0]], dtype=torch.complex128).view(
+                "gr": torch.tensor([[0.0, 1.0], [0.0, 0.0]], dtype=torch.complex128).view(
                     1, 2, 2, 1
                 ),
                 "rr": torch.tensor([[0.0, 0.0], [0.0, 1.0]], dtype=torch.complex128).view(
@@ -190,10 +190,10 @@ class MPO(Operator[complex, torch.Tensor, MPS]):
                 "00": torch.tensor([[1.0, 0.0], [0.0, 0.0]], dtype=torch.complex128).view(
                     1, 2, 2, 1
                 ),
-                "01": torch.tensor([[0.0, 0.0], [1.0, 0.0]], dtype=torch.complex128).view(
+                "10": torch.tensor([[0.0, 0.0], [1.0, 0.0]], dtype=torch.complex128).view(
                     1, 2, 2, 1
                 ),
-                "10": torch.tensor([[0.0, 1.0], [0.0, 0.0]], dtype=torch.complex128).view(
+                "01": torch.tensor([[0.0, 1.0], [0.0, 0.0]], dtype=torch.complex128).view(
                     1, 2, 2, 1
                 ),
                 "11": torch.tensor([[0.0, 0.0], [0.0, 1.0]], dtype=torch.complex128).view(

emu_mps/mps.py

@@ -394,7 +394,7 @@ class MPS(State[complex, torch.Tensor]):
         result.truncate()
         return result
 
-    def __rmul__(self, scalar: complex) -> MPS:
+    def __rmul__(self, scalar: complex | torch.Tensor) -> MPS:
         """
         Multiply an MPS by a scalar.
 
@@ -419,7 +419,7 @@ class MPS(State[complex, torch.Tensor]):
             eigenstates=self.eigenstates,
         )
 
-    def __imul__(self, scalar: complex) -> MPS:
+    def __imul__(self, scalar: complex | torch.Tensor) -> MPS:
         return self.__rmul__(scalar)
 
     @classmethod

emu_mps/mps_backend_impl.py

@@ -155,12 +155,16 @@ class MPSBackendImpl:
             f"""To resume: `MPSBackend().resume("{self.autosave_file}")`"""
         )
         self.last_save_time = time.time()
+        requested_num_gpus = self.config.num_gpus_to_use
 
-        if self.config.num_gpus_to_use > DEVICE_COUNT:
+        if requested_num_gpus is None:
+            requested_num_gpus = DEVICE_COUNT
+        elif requested_num_gpus > DEVICE_COUNT:
             self.config.logger.warning(
-                f"Requested to use {self.config.num_gpus_to_use} GPU(s) "
+                f"Requested to use {requested_num_gpus} GPU(s) "
                 f"but only {DEVICE_COUNT if DEVICE_COUNT > 0 else 'cpu'} available"
             )
+        self.resolved_num_gpus = requested_num_gpus
 
     def __getstate__(self) -> dict:
         d = self.__dict__.copy()
@@ -211,7 +215,7 @@ class MPSBackendImpl:
                 self.qubit_count,
                 precision=self.config.precision,
                 max_bond_dim=self.config.max_bond_dim,
-                num_gpus_to_use=self.config.num_gpus_to_use,
+                num_gpus_to_use=self.resolved_num_gpus,
             )
             return
 
@@ -239,7 +243,7 @@ class MPSBackendImpl:
             [f.detach().clone() for f in initial_state.factors],
             precision=self.config.precision,
             max_bond_dim=self.config.max_bond_dim,
-            num_gpus_to_use=self.config.num_gpus_to_use,
+            num_gpus_to_use=self.resolved_num_gpus,
             eigenstates=initial_state.eigenstates,
         )
         initial_state.truncate()
@@ -259,7 +263,7 @@ class MPSBackendImpl:
                 else self.full_interaction_matrix
             ),
             hamiltonian_type=self.hamiltonian_type,
-            num_gpus_to_use=self.config.num_gpus_to_use,
+            num_gpus_to_use=self.resolved_num_gpus,
         )
 
         update_H(
@@ -447,7 +451,7 @@ class MPSBackendImpl:
             self.hamiltonian = make_H(
                 interaction_matrix=self.full_interaction_matrix,
                 hamiltonian_type=self.hamiltonian_type,
-                num_gpus_to_use=self.config.num_gpus_to_use,
+                num_gpus_to_use=self.resolved_num_gpus,
             )
 
         if not self.is_finished():

emu_mps/mps_config.py

@@ -3,7 +3,6 @@ from types import MethodType
 
 import copy
 
-from emu_base import DEVICE_COUNT
 from emu_mps.mps import MPS, DEFAULT_MAX_BOND_DIM, DEFAULT_PRECISION
 from emu_mps.mpo import MPO
 from emu_mps.solver import Solver
@@ -45,8 +44,12 @@ class MPSConfig(EmulationConfig):
             The size of the krylov subspace that the Lanczos algorithm maximally builds
         extra_krylov_tolerance:
             The Lanczos algorithm uses this*precision as the convergence tolerance
-        num_gpus_to_use: During the simulation, distribute the state over this many GPUs
-            0=all factors to cpu. As shown in the benchmarks, using multiple GPUs might
+        num_gpus_to_use: number of GPUs to be used in a given simulation.
+            - if it is set to a number `n > 0`, the state will be distributed across `n` GPUs.
+            - if it is set to `n = 0`, the entire simulation runs on the CPU.
+            - if it is `None` (the default value), the backend internally chooses the number of GPUs
+            based on the hardware availability during runtime.
+        As shown in the benchmarks, using multiple GPUs might
             alleviate memory pressure per GPU, but the runtime should be similar.
         optimize_qubit_ordering: Optimize the register ordering. Improves performance and
             accuracy, but disables certain features.
@@ -86,7 +89,7 @@ class MPSConfig(EmulationConfig):
         max_bond_dim: int = DEFAULT_MAX_BOND_DIM,
         max_krylov_dim: int = 100,
         extra_krylov_tolerance: float = 1e-3,
-        num_gpus_to_use: int = DEVICE_COUNT,
+        num_gpus_to_use: int | None = None,
         optimize_qubit_ordering: bool = False,
         interaction_cutoff: float = 0.0,
         log_level: int = logging.INFO,

{emu_mps-2.4.1.dist-info → emu_mps-2.4.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: emu-mps
-Version: 2.4.1
+Version: 2.4.2
 Summary: Pasqal MPS based pulse emulator built on PyTorch
 Project-URL: Documentation, https://pasqal-io.github.io/emulators/
 Project-URL: Repository, https://github.com/pasqal-io/emulators
@@ -25,7 +25,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.10
-Requires-Dist: emu-base==2.4.1
+Requires-Dist: emu-base==2.4.2
 Description-Content-Type: text/markdown
 
 <div align="center">

{emu_mps-2.4.1.dist-info → emu_mps-2.4.2.dist-info}/RECORD

@@ -1,12 +1,12 @@
-emu_mps/__init__.py,sha256=R4Fw8r-_GEeckaxyQ9leUKVfLoukcrwvaTQsTbzxhbs,708
-emu_mps/algebra.py,sha256=vi3d4xOBEsfQ7gsjYNns9AMLjJXXXppYVEThavNvAg0,5408
+emu_mps/__init__.py,sha256=fEovcc3ow-4zoEodViCEyn2uZWnb-uwVSG-uRBs-g7U,708
+emu_mps/algebra.py,sha256=VZ5uaX5PYWGqDCpRKKr819BLMMtT0pKDxc2HrlLCdgU,5423
 emu_mps/custom_callback_implementations.py,sha256=WeczmO6qkvBIipvXLqX45i3D7M4ovOrepusIGs6d2Ts,2420
 emu_mps/hamiltonian.py,sha256=gOPxNOBmk6jRPPjevERuCP_scGv0EKYeAJ0uxooihes,15622
-emu_mps/mpo.py,sha256=2HNwN4Fz04QIVfPcPaMmt2q89ZBxN3K-vVeiFkOtqzs,8049
-emu_mps/mps.py,sha256=KEXrLdqhi5EvpdX-9J38ZfrRdt3oDmcGsVLghMPUfQw,21600
+emu_mps/mpo.py,sha256=-kbElxfodWh3IQa8QDor4TgLJE-zsaMRI5PZ6dZpYck,8049
+emu_mps/mps.py,sha256=1aMvY4NQSBeAwzTwHRegXncGQqm-1g05W00OimFNzt8,21630
 emu_mps/mps_backend.py,sha256=bS83qFxvdoK-c12_1WaPw6O7xUc7vdWifZNHUzNP5sM,2091
-emu_mps/mps_backend_impl.py,sha256=Pcbn27lhg3n3Lzo3CGwhlWPqPi-8YV1ntkgl901AoUs,30400
-emu_mps/mps_config.py,sha256=QmwgU8INEnxrxZkhboYIsHGwml0UhgPkddT5zh8KVBU,8867
+emu_mps/mps_backend_impl.py,sha256=B8hi21uHFUSVJ3k5J4A4fXqyQo4sNHSb2uddN3lUYPA,30558
+emu_mps/mps_config.py,sha256=j7rho3edFzDxPO_VX7j5jc0Drw9wO2NWRymkqZ9hzmU,9128
 emu_mps/observables.py,sha256=4C_ewkd3YkJP0xghTrGUTgXUGvJRCQcetb8cU0SjMl0,1900
 emu_mps/solver.py,sha256=M9xkHhlEouTBvoPw2UYVu6kij7CO4Z1FXw_SiGFtdgo,85
 emu_mps/solver_utils.py,sha256=EnNzEaUrtTMQbrWoqOy8vyDsQwlsfQCUc2HgOp4z8dk,8680
@@ -14,6 +14,6 @@ emu_mps/utils.py,sha256=pW5N_EbbGiOviQpJCw1a0pVgEDObP_InceNaIqY5bHE,6982
 emu_mps/optimatrix/__init__.py,sha256=fBXQ7-rgDro4hcaBijCGhx3J69W96qcw5_3mWc7tND4,364
 emu_mps/optimatrix/optimiser.py,sha256=k9suYmKLKlaZ7ozFuIqvXHyCBoCtGgkX1mpen9GOdOo,6977
 emu_mps/optimatrix/permutations.py,sha256=9DDMZtrGGZ01b9F3GkzHR3paX4qNtZiPoI7Z_Kia3Lc,3727
-emu_mps-2.4.1.dist-info/METADATA,sha256=2SUt6GLqhz_6-2ewuVqDH9xvz3gx1ZROU975intvuwk,3587
-emu_mps-2.4.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-emu_mps-2.4.1.dist-info/RECORD,,
+emu_mps-2.4.2.dist-info/METADATA,sha256=SMYIZXDve_o9aZ7K1EfB7V6s8FBqA_wltE5a8ecNUf4,3587
+emu_mps-2.4.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+emu_mps-2.4.2.dist-info/RECORD,,