experimaestro 1.3.5__py3-none-any.whl → 1.3.6__py3-none-any.whl

experimaestro/core/context.py

@@ -36,13 +36,18 @@ class SerializedPath:
 
 
 class SerializationContext:
+    """Context when serializing experimaestro configurations"""
+
     save_directory: Optional[Path]
     var_path: List[str]
     serialized: Set[int]
 
-    """Context when serializing experimaestro configurations"""
-
     def __init__(self, *, save_directory: Optional[Path] = None):
+        """Creates a new serialization context
+
+        :param save_directory: Defines the directory where `SerializedPath` are
+            stored
+        """
         self.save_directory = save_directory
         self.var_path = []
         self.serialized = set()

experimaestro/scheduler/base.py

@@ -5,7 +5,7 @@ from pathlib import Path
 from shutil import rmtree
 import threading
 import time
-from typing import List, Optional, Set, TypeVar, Union, TYPE_CHECKING
+from typing import Any, List, Optional, Set, TypeVar, Union, TYPE_CHECKING
 import enum
 import signal
 import asyncio
@@ -482,7 +482,7 @@ class Scheduler:
 
         return None
 
-    async def aio_submit(self, job: Job) -> JobState:
+    async def aio_submit(self, job: Job) -> JobState:  # noqa: C901
         """Main scheduler function: submit a job, run it (if needed), and returns
         the status code
         """
@@ -693,14 +693,25 @@ ServiceClass = TypeVar("ServiceClass", bound=Service)
 
 
 class experiment:
-    """Experiment context"""
+    """Main experiment object
+
+    It is a context object, i.e. experiments is run with
+
+    ```py
+        with experiment(...) as xp:
+            ...
+    ```
+    """
 
     # Current experiment
     CURRENT: Optional["experiment"] = None
 
     @staticmethod
     def current() -> "experiment":
-        """Returns the current experiment, but checking first if set"""
+        """Returns the current experiment, but checking first if set
+
+        If there is no current experiment, raises an AssertError
+        """
         assert experiment.CURRENT is not None, "No current experiment defined"
         return experiment.CURRENT
 
@@ -718,9 +729,18 @@ class experiment:
         """
         :param env: an environment -- or a working directory for a local
             environment
-        :param port: the port for the web server (overrides environment port if
-            any). Use None to avoid running a web server (default when dry run).
+
+        :param name: the identifier of the experiment
+
         :param launcher: The launcher (if not provided, inferred from path)
+
+        :param host: The host for the web server (overrides the environment if
+            set)
+        :param port: the port for the web server (overrides the environment if
+            set). Use negative number to avoid running a web server (default when dry run).
+
+        :param run_mode: The run mode for the experiment (normal, generate run
+            files, dry run)
         """
 
         from experimaestro.server import Server
@@ -759,7 +779,7 @@ class experiment:
         self.scheduler = Scheduler(self, name)
         self.server = (
             Server(self.scheduler, settings.server)
-            if settings.server.port is not None
+            if (settings.server.port is not None and settings.server.port >= 0)
             and self.workspace.run_mode == RunMode.NORMAL
             else None
         )
@@ -842,7 +862,9 @@ class experiment:
         self.environment.setenv(name, value)
 
     def token(self, name: str, count: int):
-        """Returns a token for this experiment depending on the host"""
+        """Returns a token for this experiment
+
+        The token is the default token of the workspace connector"""
         return self.workspace.connector.createtoken(name, count)
 
     def __enter__(self):
@@ -928,8 +950,43 @@ class experiment:
                 self.server.stop()
 
     def add_service(self, service: ServiceClass) -> ServiceClass:
-        """Adds a service (e.g. tensorboard viewer) to the experiment"""
+        """Adds a service (e.g. tensorboard viewer) to the experiment
+
+        :param service: A service instance
+        :type service: Service
+        :return: The same service instance
+        """
         self.services[service.id] = service
         for listener in self.scheduler.listeners:
             listener.service_add(service)
         return service
+
+    def save(self, obj: Any, name: str = "default"):
+        """Serializes configurations.
+
+        Saves configuration objects within the experimental directory
+
+        :param obj: The object to save
+        :param name: The name of the saving directory (default to `default`)
+        """
+
+        if self.workspace.run_mode == RunMode.NORMAL:
+            from experimaestro import save
+
+            save_dir = self.workdir / "data" / name
+            save_dir.mkdir(exist_ok=True, parents=True)
+
+            save(obj, save_dir)
+
+    def load(self, reference: str, name: str = "default"):
+        """Serializes configurations.
+
+        Loads configuration objects from an experimental directory
+
+        :param reference: The name of the experiment
+        :param name: The name of the saving directory (default to `default`)
+        """
+        from experimaestro import load
+
+        path = self.workspace.experimentspath / reference / "data" / name
+        return load(path)

experimaestro/scheduler/services.py

@@ -6,6 +6,8 @@ from typing import Set
 
 
 class ServiceListener:
+    """A service listener"""
+
     def service_state_changed(service):
         pass
 
@@ -18,6 +20,12 @@ class ServiceState(Enum):
 
 
 class Service:
+    """An experiment service
+
+    Services can be associated with an experiment. They send
+    notifications to service listeners.
+    """
+
     id: str
     _state: ServiceState = ServiceState.STOPPED
 
@@ -25,9 +33,17 @@ class Service:
         self.listeners: Set[ServiceListener] = set()
 
     def add_listener(self, listener: ServiceListener):
+        """Adds a listener
+
+        :param listener: The listener to add
+        """
         self.listeners.add(listener)
 
     def remove_listener(self, listener: ServiceListener):
+        """Removes a listener
+
+        :param listener: The listener to remove
+        """
         self.listeners.remove(listener)
 
     def description(self):
@@ -47,6 +63,8 @@ class Service:
 
 
 class WebService(Service):
+    """Web service"""
+
     def __init__(self):
         super().__init__()
         self.url = None

{experimaestro-1.3.5.dist-info → experimaestro-1.3.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: experimaestro
-Version: 1.3.5
+Version: 1.3.6
 Summary: "Experimaestro is a computer science experiment manager"
 Home-page: https://github.com/experimaestro/experimaestro-python
 License: GPL-3

{experimaestro-1.3.5.dist-info → experimaestro-1.3.6.dist-info}/RECORD

@@ -10,7 +10,7 @@ experimaestro/connectors/local.py,sha256=6tlaZb0tvNS2mjsapiVbfY7kIfLICJad137VXBM
 experimaestro/connectors/ssh.py,sha256=A6qObY_phynZVQFdAsyymP9c0fiUHwn04nShROzMrec,7896
 experimaestro/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 experimaestro/core/arguments.py,sha256=dW32opqNEsULYr6nR7Zk8PqHsSCbLPclfXofw27GTpI,5620
-experimaestro/core/context.py,sha256=70ZhDBobGDl0wEyvZyqyrnWagLs7EiRf0cBSXp1N3Lc,2479
+experimaestro/core/context.py,sha256=Q8_ngiHRBZ0laavXRJNiDvdCprrnROVTWaHfrwMdlG4,2638
 experimaestro/core/objects.py,sha256=AuviYnITYuoKkj2MR6ovyU7cMl8BgJfXp5yAKaunlJo,62571
 experimaestro/core/objects.pyi,sha256=D8-kd-NU-pRl9-_ktXUne_k1YH6TG3VGqRaKV8mrZwk,7003
 experimaestro/core/serialization.py,sha256=nLlSSqerH9lqiWvqkCxz0YRRW8M1y56ainZ9_GVgTMk,3432
@@ -45,10 +45,10 @@ experimaestro/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 experimaestro/rpyc.py,sha256=ZRKol-3tVoeoUITLNFenLF4dhWBLW_FvSV_GvsypmeI,3605
 experimaestro/run.py,sha256=tH9oG7o8_c7cp0cyBLIzWN7CVYjtz72SChz2X-FjYhs,4455
 experimaestro/scheduler/__init__.py,sha256=ERmmOxz_9mUkIuccNbzUa5Y6gVLLVDdyc4cCxbCCUbY,20
-experimaestro/scheduler/base.py,sha256=StJMB-9aPv5r91Zfo8ZNVButPowVhWjtqi3esf5Husk,29257
+experimaestro/scheduler/base.py,sha256=B4L3E-TnNjt0kutaEVrnA3-rTpoCfuXZO9rzH28phNI,30945
 experimaestro/scheduler/dependencies.py,sha256=n9XegwrmjayOIxt3xhuTEBVEBGSq4oeVdzz-FviDGXo,1994
 experimaestro/scheduler/environment.py,sha256=ZaSHSgAcZBmIj7b_eS1OvNQOuVLFvuw-qvqtYrc3Vms,2393
-experimaestro/scheduler/services.py,sha256=lrxhM4feQuGjtBVHJbEdmzI9x-bPBa5rXVcaDjjiSqU,1820
+experimaestro/scheduler/services.py,sha256=aCKkNZMULlceabqf-kOs_-C7KPINnjU3Q-I00o5x6iY,2189
 experimaestro/scheduler/workspace.py,sha256=xATJi6-GJcpdwB4alliJnmAuvwt-URUiUKUfq5scUac,1731
 experimaestro/scriptbuilder.py,sha256=-wq4jgH8eKpjKWyU_7SxU7MNJLfPqZ0VdERv6rrkJ88,4235
 experimaestro/server/__init__.py,sha256=F2bzLf2q29Haj2OIbPA26r5WVbaipBNylIozg-As758,10854
@@ -137,8 +137,8 @@ experimaestro/utils/resources.py,sha256=gDjkrRjo7GULWyXmNXm_u1uqzEIAoAvJydICk56n
 experimaestro/utils/settings.py,sha256=jpFMqF0DLL4_P1xGal0zVR5cOrdD8O0Y2IOYvnRgN3k,793
 experimaestro/utils/yaml.py,sha256=jEjqXqUtJ333wNUdIc0o3LGvdsTQ9AKW9a9CCd-bmGU,6766
 experimaestro/xpmutils.py,sha256=S21eMbDYsHfvmZ1HmKpq5Pz5O-1HnCLYxKbyTBbASyQ,638
-experimaestro-1.3.5.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-experimaestro-1.3.5.dist-info/METADATA,sha256=dk-rmZJ-s5UfCM1f3rL4mFU4j4Zm3AaZX65LFxWJR5U,5336
-experimaestro-1.3.5.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-experimaestro-1.3.5.dist-info/entry_points.txt,sha256=PhaEili_fDgn5q7rBJGip_uhGkRBq5l3Yuhg91zkcbk,574
-experimaestro-1.3.5.dist-info/RECORD,,
+experimaestro-1.3.6.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+experimaestro-1.3.6.dist-info/METADATA,sha256=oIMCcjrUWC-mHhVFI2K2aj5d-cw3JXLMqlmID1LD4Bo,5336
+experimaestro-1.3.6.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+experimaestro-1.3.6.dist-info/entry_points.txt,sha256=PhaEili_fDgn5q7rBJGip_uhGkRBq5l3Yuhg91zkcbk,574
+experimaestro-1.3.6.dist-info/RECORD,,