Multiclass-interface 1.2__tar.gz → 1.4__tar.gz

{multiclass_interface-1.2 → multiclass_interface-1.4/Multiclass_interface.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Multiclass_interface
-Version: 1.2
+Version: 1.4
 Summary: Multiclass interface
 Author-email: "Mads M. Pedersen" <mmpe@dtu.dk>
 Project-URL: Homepage, https://gitlab.windenergy.dtu.dk/DYNAMIKS/multiclass_interface

{multiclass_interface-1.2/Multiclass_interface.egg-info → multiclass_interface-1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: Multiclass_interface
-Version: 1.2
+Version: 1.4
 Summary: Multiclass interface
 Author-email: "Mads M. Pedersen" <mmpe@dtu.dk>
 Project-URL: Homepage, https://gitlab.windenergy.dtu.dk/DYNAMIKS/multiclass_interface

{multiclass_interface-1.2 → multiclass_interface-1.4}/multiclass_interface/mpi_interface.py

@@ -7,17 +7,20 @@ comm = None
 size = 1
 rank = 0
 name = ""
-main = True
+mpi = False
 
 
-def activate_mpi():
-    global comm, size, rank, name, main
+def activate_mpi(collective_mpi=True, loop_until_close=True, terminate_on_close=True):
+    global comm, size, rank, name, mpi, LOOP_UNTIL_CLOSE, TERMINATE_ON_CLOSE, COLLECTIVE_MPI
     from mpi4py import MPI
     comm = MPI.COMM_WORLD
     size = MPI.COMM_WORLD.Get_size()
     rank = MPI.COMM_WORLD.Get_rank()
     name = MPI.Get_processor_name()
-    main = rank == 0
+    mpi = True
+    COLLECTIVE_MPI = collective_mpi
+    LOOP_UNTIL_CLOSE = loop_until_close
+    TERMINATE_ON_CLOSE = terminate_on_close
 
 
 MPIClassInterfaceAttributes = {
@@ -33,8 +36,9 @@ MPIClassInterfaceAttributes = {
     'closed'}
 
 
-LOOP_UNTIL_CLOSE = True
-TERMINATE_ON_CLOSE = True
+LOOP_UNTIL_CLOSE = True  # MPI workers (rank>0) will enter the work loop and wait for commands from rank 0
+TERMINATE_ON_CLOSE = True  # MPI workers (rank>0) will terminate (sys.exit) when the close command is called via rank0
+COLLECTIVE_MPI = True  # rank0 acts as a single point of contact (scatters command+arg and gathers results)
 
 
 class MPIClassInterface():
@@ -53,10 +57,9 @@ class MPIClassInterface():
             self.object = Dummy()
         self.closed = False
 
-        if rank == 0:
-            self.use_rank = np.array([True] * size)
-            self.use_rank[len(args_lst):] = False
-        elif LOOP_UNTIL_CLOSE:
+        self.use_rank = np.array([True] * size)
+        self.use_rank[len(args_lst):] = False
+        if rank > 0 and COLLECTIVE_MPI and LOOP_UNTIL_CLOSE:
             self.work_loop()
 
     def __enter__(self):
@@ -133,13 +136,18 @@ class MPIClassInterface():
     def __getattribute__(self, name):
         if name in MPIClassInterfaceAttributes:
             return object.__getattribute__(self, name)
-        elif rank > 0:
+        elif COLLECTIVE_MPI and rank > 0:
             self.work_loop()
             return lambda *args, **kwargs: 1
+        elif not self.use_rank[rank]:
+            raise ChildProcessError('MPI worker not used')
 
         def wrap(*args, **kwargs):
-            inp = [self.get_input(name, i, args, kwargs) for i in range(size)]
-            return self.run_task(inp)
+            if COLLECTIVE_MPI:
+                inp = [self.get_input(name, i, args, kwargs) for i in range(size)]
+                return self.run_task(inp)
+            else:
+                return self.do_task(name, args, kwargs)
 
         if hasattr(getattr(self.object, name), '__call__'):
             return wrap
@@ -162,11 +170,14 @@ class MPIClassInterface():
 
     def close(self):
         if not self.closed:
-            if rank == 0:
-                res = self.run_task([('close', [], {}) for _ in range(size)])
+            if COLLECTIVE_MPI:
+                if rank == 0:
+                    res = self.run_task([('close', [], {}) for _ in range(size)])
+                else:
+                    self.work_loop()
+                    res = None
             else:
-                self.work_loop()
-                res = None
+                res = self.do_task('close', [], {})
             self.closed = True
 
 

{multiclass_interface-1.2 → multiclass_interface-1.4}/multiclass_interface/tests/test_mpi.py

@@ -42,11 +42,28 @@ def mpitest_mpi_ProcessClass():
     with ProcessClass(MyTest) as cls:
         myTest = cls(1)
         assert myTest.get_id() == 1
-    print("done, test_mpi_ProcessClass")
+    print("done, test_mpi_ProcessClass", flush=True)
+
+
+def mpitest_non_collective_mpi():
+    mpi_interface.COLLECTIVE_MPI = False
+    rank = mpi_interface.rank
+    import time
+    N = 3
+    with MPIClassInterface(MyTest, [(i + 10,) for i in range(N)]) as m:
+
+        try:
+            assert m.get_id() == rank + 10
+            assert rank < N  # rank > N will fail with ChildProcessError
+        except ChildProcessError:
+            pass
+
+    mpi_interface.COLLECTIVE_MPI = True
 
 
 def mpitest_all():
     mpi_interface.activate_mpi()
+
     mpi_interface.exit_mpi_on_close = False
     rank = mpi_interface.rank
     from multiclass_interface.tests.test_multiprocessinterface import test_attribute, test_missing_attribute, test_execption, test_setattr, test_setattr_method
@@ -67,13 +84,14 @@ def mpitest_all():
         run(f)
 
     try:
-        with MPIClassInterface(MyTest, [(1,), (2,)]) as mpici:
+        with MPIClassInterface(MyTest, [(1,), (2,), (3,)]) as mpici:
             for f in [test_attribute, test_missing_attribute, test_execption, test_setattr, test_setattr_method]:
-                break
+
                 run(f, mpici)
 
     except ChildProcessError:
         pass
-    mpi_interface.TERMINATE_ON_CLOSE = True
+
+    run(mpitest_non_collective_mpi)
 
     print(f"Rank {rank} Done test_all")

{multiclass_interface-1.2 → multiclass_interface-1.4}/multiclass_interface/version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.2'
-__version_tuple__ = version_tuple = (1, 2)
+__version__ = version = '1.4'
+__version_tuple__ = version_tuple = (1, 4)

{multiclass_interface-1.2 → multiclass_interface-1.4}/sequence_diagrams.md

@@ -1,3 +1,12 @@
+# Sequence diagrams
+- [ThreadClass](#threadclass)
+- [ProcessClass](#processclass)
+- [MultiThreadClassInterface](#multithreadclassinterface)
+- [MultiProcessClassInterface](#multiprocessclassinterface)
+- [MPIClassInterface](#mpiclassinterface)
+- [MPIClassInterface(LOOP_UNTIL_CLOSE=False)](#mpiclassinterfaceloop_until_closefalse)
+- [MPIClassInterface(COLLECTIVE_MPI=False)](#mpiclassinterfacecollective_mpifalse)
+
 ## ThreadClass
 ```mermaid
 sequenceDiagram
@@ -42,7 +51,7 @@ This means:
 - Libraries (dll/so) will have their own memory space (important if multiple instances are launched)
 - Multiple processes allows parallel execution
 
-## MultiProcessClassInterface
+## MultiThreadClassInterface
 
 ```mermaid
 sequenceDiagram
@@ -166,7 +175,7 @@ sequenceDiagram
     MPI2->>-MPI2: 
 ```
 
-## MPIClassInterface
+## MPIClassInterface(LOOP_UNTIL_CLOSE=False)
 
 Setting `mpi_interface.LOOP_UNTIL_CLOSE=False` results in the following workflow
 
@@ -226,3 +235,41 @@ sequenceDiagram
 ```
 
 
+## MPIClassInterface(COLLECTIVE_MPI=False)
+Setting `mpi_interface.COLLECTIVE_MPI=False` results in the following workflow
+
+```mermaid
+sequenceDiagram
+    
+    participant MPI0 as MPI,rank0<br>MPIClassInterface
+    
+    
+    MPI0->>+MPI0: cls=A, [(args0),(args1)]
+    
+    
+    create participant A0
+    MPI0->>+A0: args0
+    
+    participant MPI1 as MPI,rank1<br>MPIClassInterface
+    MPI1->>+MPI1: cls=A, [(args0),(args1)]
+    create participant A1
+    MPI1->>A1: args1
+    participant MPI2 as MPI,rank2<br>MPIClassInterface
+    MPI2->>MPI2: cls=A, [(args0),(args1)]
+    
+    MPI0->>+MPI0:~a.f([args0,args1])
+    MPI1->>+MPI1:~a.f([args0,args1])
+    MPI2->>+MPI2:~a.f([args0,args1])
+    
+    
+    MPI0->>+A0: f(args0)
+    MPI1->>+A1: f(args1)
+    MPI2->>-MPI2: ChildProcessError
+    A0->>-MPI0: res0
+    A1->>-MPI1: res1
+        
+    MPI0->>-MPI0: res0
+    MPI1->>-MPI1: res1
+    
+```
+