experimaestro 0.21.0__zip → 0.23.0__zip

{experimaestro-0.21.0 → experimaestro-0.23.0}/CHANGELOG.md

@@ -1,3 +1,20 @@
+## 0.23.0 (2023-04-07)
+
+### Feat
+
+- submit hooks to allow e.g. changing the environment variables
+
+## 0.22.0 (2023-04-05)
+
+### Feat
+
+- tags as immutable and hashable dicts
+
+### Fix
+
+- corrected service status update for servers
+- improved server
+
 ## 0.21.0 (2023-03-28)
 
 ### Feat

{experimaestro-0.21.0 → experimaestro-0.23.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: experimaestro
-Version: 0.21.0
+Version: 0.23.0
 Summary: "Experimaestro is a computer science experiment manager"
 Home-page: https://github.com/experimaestro/experimaestro-python
 Author: Benjamin Piwowarski
@@ -127,6 +127,23 @@ if __name__ == "__main__":
 
 which can be launched with `python test.py /tmp/helloworld-workdir`
 
+## 0.23.0 (2023-04-07)
+
+### Feat
+
+- submit hooks to allow e.g. changing the environment variables
+
+## 0.22.0 (2023-04-05)
+
+### Feat
+
+- tags as immutable and hashable dicts
+
+### Fix
+
+- corrected service status update for servers
+- improved server
+
 ## 0.21.0 (2023-03-28)
 
 ### Feat

{experimaestro-0.21.0 → experimaestro-0.23.0}/app/src/Services.tsx

@@ -17,7 +17,7 @@ const Services = () => {
     }
     return <NavDropdown title="Services" id="basic-nav-dropdown">{
         services.ids.map(id =>
-            <NavDropdown.Item key={id} href={`/services/${id}`}>
+            <NavDropdown.Item key={id} href={`/services/${id}`} target='_blank'>
                 <code>{id}</code> {services.byId[id].description}{" "}
                 {STATE_COMPONENTS[services.byId[id].state] ?? services.byId[id].state}
             </NavDropdown.Item>

{experimaestro-0.21.0 → experimaestro-0.23.0}/docs/experiments/plan.md

@@ -10,13 +10,13 @@ the config/task instance, as in the example below:
 
 !!! example
 
-````py3 linenums="1"
+    ```py3 linenums="1"
 
-model = Model1(layers=3)
-learnedmodel = Learn(epochs=100)
-learnedmodel.model = model
-learnedmodel.submit()
-```
+    model = Model1(layers=3)
+    learnedmodel = Learn(epochs=100)
+    learnedmodel.model = model
+    learnedmodel.submit()
+    ```
 
 - line 1: the `Model1` configuration is set with argument `layers` set to `3`.
 - line 2: the `Learn` task is configured with parameter `epochs` set to 100

{experimaestro-0.21.0 → experimaestro-0.23.0}/docs/index.md

@@ -34,7 +34,8 @@ features. More precisely, it
    importantly, it defines experiments imperatively and not declaratively.
 
 !!! note
-Experimaestro and datamaestro are described in the following paper
+
+    Experimaestro and datamaestro are described in the following paper
 
     Benjamin Piwowarski. 2020.
     [Experimaestro and Datamaestro: Experiment and Dataset Managers (for IR).](https://doi.org/10.1145/3397271.3401410)

{experimaestro-0.21.0 → experimaestro-0.23.0}/pyproject.toml

@@ -4,7 +4,7 @@ fallback_version = "0.0.0-dev"
 
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "0.21.0"
+version = "0.23.0"
 changelog_start_rev = "0.15.0"
 tag_format = "$version"
 update_changelog_on_bump = true

{experimaestro-0.21.0 → experimaestro-0.23.0}/requirements.txt

@@ -2,8 +2,8 @@
 click
 omegaconf
 
-# Supports Annotated[T, ...]
-typing_extensions >= 3.7.4.3; python_version < "3.9"
+# Supports recent typing
+typing_extensions >= 4.2; python_version < "3.11"
 cached_property; python_version < "3.9"
 
 # Other
@@ -15,13 +15,14 @@ tqdm
 docstring_parser
 termcolor >= 2.0.0
 requests
+sortedcontainers
 pyparsing
 # Parse size
 humanfriendly
 huggingface_hub ~= 0.11.1
 
 # server
-eventlet
+gevent
 flask
 flask-socketio
 

{experimaestro-0.21.0 → experimaestro-0.23.0}/setup.cfg

@@ -70,7 +70,7 @@ ignore = D200, D203, D213, D406, D407   # Google conventions
 
 [flake8]
 doctests = True
-exclude = .git, .eggs, __pycache__, tests/, docs/, build/, dist/
+exclude = .git, .eggs, __pycache__, tests/, docs/, build/, dist/, app/
 max-line-length = 88
 extend-ignore = E203
 

{experimaestro-0.21.0 → experimaestro-0.23.0}/src/experimaestro/__init__.py

@@ -15,6 +15,7 @@ from .annotations import (
     cache,
     Identifier,
     Array,
+    TagDict,
     tag,
     tags,
     tagspath,
@@ -48,17 +49,19 @@ from .core.objects import (
     SerializedConfig,
     Serialized,
 )
+from .core.types import Any, SubmitHook, submit_hook_decorator
+from .launchers import Launcher
 from .scheduler.environment import Environment
 from .scheduler.workspace import Workspace, RunMode
 from .scheduler import Scheduler, experiment, FailedExperiment
 from .notifications import progress, tqdm
-from .core.types import Any
 from .checkers import Choices
 from .xpmutils import DirectoryContext
 from .mkdocs.annotations import documentation
+from .scheduler.base import Job
 
 
-def set_launcher(launcher):
+def set_launcher(launcher: Launcher):
     Workspace.CURRENT.launcher = launcher
 
 

{experimaestro-0.21.0 → experimaestro-0.23.0}/src/experimaestro/__main__.py

@@ -125,7 +125,7 @@ def diff(path: Path):
     """Show the reason of the identifier change for a job"""
     from experimaestro.tools.jobs import load_job
     from experimaestro import Config
-    from experimaestro.core.objects import GenerationContext
+    from experimaestro.core.objects import ConfigWalkContext
 
     _, job = load_job(path / "params.json", discard_id=False)
     _, new_job = load_job(path / "params.json")

{experimaestro-0.21.0 → experimaestro-0.23.0}/src/experimaestro/annotations.py

@@ -1,11 +1,9 @@
 # Import Python modules
 
-import sys
 import inspect
-import logging
 from pathlib import Path
 from typing import Callable, Type as TypingType, Optional, TypeVar, Union
-
+from sortedcontainers import SortedDict
 import experimaestro.core.objects as objects
 import experimaestro.core.types as types
 from experimaestro.generators import PathGenerator
@@ -33,12 +31,18 @@ class config:
         """[summary]
 
         Keyword Arguments:
-            identifier {Identifier, str} -- Unique identifier of the type, generate by default (None)
-            description {str} -- (deprecated, use comments) Description of the config/task, use comments with (default) None
-            register {bool} -- False if the type should not be registered (debug only)
+            identifier {Identifier, str} -- Unique identifier of the type,
+            generate by default (None)
+
+            description {str} -- (deprecated, use
+            comments) Description of the config/task, use comments with
+            (default) None
+
+            register {bool} -- False if the type should not be
+            registered (debug only)
 
-        The identifier, if not specified, will be set to `X.CLASSNAME`(by order of priority),
-        where X is:
+        The identifier, if not specified, will be set to `X.CLASSNAME`(by order
+        of priority), where X is:
             - the parent identifier
             - the module qualified name
         """
@@ -207,8 +211,12 @@ class pathoption(param):
         self.generator = PathGenerator(path)
 
 
-STDERR = lambda jobcontext, config: "%s.err" % jobcontext.name
-STDOUT = lambda jobcontext, config: "%s.out" % jobcontext.name
+def STDERR(jobcontext, config):
+    return "%s.err" % jobcontext.name
+
+
+def STDOUT(jobcontext, config):
+    return "%s.out" % jobcontext.name
 
 
 class constant(param):
@@ -229,7 +237,6 @@ def cache(name: str):
     """Use a cache path for a given config"""
 
     def annotate(method):
-
         return objects.cache(method, name)
 
     return annotate
@@ -243,9 +250,19 @@ def tag(value):
     return objects.TaggedValue(value)
 
 
-def tags(value):
+class TagDict(SortedDict):
+    """A hashable dictionary"""
+
+    def __hash__(self):
+        return hash(tuple((key, value) for key, value in self.items()))
+
+    def __setitem__(self, key, value):
+        raise Exception("A tag dictionary is not mutable")
+
+
+def tags(value) -> TagDict:
     """Return the tags associated with a value"""
-    return value.__xpm__.tags()
+    return TagDict(value.__xpm__.tags())
 
 
 def _normalizepathcomponent(v: Any):
@@ -256,10 +273,9 @@ def _normalizepathcomponent(v: Any):
 
 def tagspath(value: Config):
     """Return a unique path made of tags and their values"""
-    sortedtags = sorted(value.__xpm__.tags().items(), key=lambda x: x[0])
     return "_".join(
         f"""{_normalizepathcomponent(key)}={_normalizepathcomponent(value)}"""
-        for key, value in sortedtags
+        for key, value in tags(value).items()
     )
 
 

{experimaestro-0.21.0 → experimaestro-0.23.0}/src/experimaestro/commandline.py

@@ -1,6 +1,5 @@
 """Command line jobs"""
 
-from collections import ChainMap
 import json
 import io
 from pathlib import Path
@@ -260,13 +259,6 @@ class CommandLineJob(Job):
 
         return None
 
-    @property
-    def environ(self):
-        return ChainMap(
-            self.workspace.environment.environ,
-            self.launcher.environ if self.launcher else {},
-        )
-
     @property
     def notificationURL(self):
         if self.launcher and self.launcher.notificationURL:

{experimaestro-0.21.0 → experimaestro-0.23.0}/src/experimaestro/core/objects.py

@@ -20,6 +20,7 @@ from typing import (
     List,
     Optional,
     Set,
+    Tuple,
     Type,
     TypeVar,
     Union,
@@ -35,6 +36,7 @@ from experimaestro.core.types import DeprecatedAttribute, ObjectType
 from .context import SerializationContext, SerializedPath, SerializedPathLoader
 
 if TYPE_CHECKING:
+    from experimaestro.scheduler.base import Job
     from experimaestro.scheduler.workspace import RunMode
     from experimaestro.launchers import Launcher
     from experimaestro.scheduler import Workspace
@@ -307,7 +309,7 @@ def add_to_path(p):
         sys.path = old_path
 
 
-class GenerationContext:
+class ConfigWalkContext:
     """Context when generating values in configurations"""
 
     @property
@@ -342,33 +344,38 @@ class GenerationContext:
 NOT_SET = object()
 
 
-class ConfigProcessing:
+class ConfigWalk:
     """Allows to perform an operation on all nested configurations"""
 
-    def __init__(self, recurse_task=False):
+    def __init__(self, context: ConfigWalkContext = None, recurse_task=False):
         """
 
-        Parameters:
-            recurse_task: Recurse into linked tasks
+        :param recurse_task: Recurse into linked tasks
+        :param context: The context, by default only tracks the position in the
+            config tree
         """
         self.recurse_task = recurse_task
+        self.context = ConfigWalkContext() if context is None else context
 
         # Stores already visited nodes
         self.visited = {}
 
-    def preprocess(self, config: "Config"):
+    def preprocess(self, config: "Config") -> Tuple[bool, Any]:
+        """Returns a tuple boolean/value
+
+        The boolean value is used to stop the processing if False.
+        The value is returned
+        """
         return True, None
 
     def postprocess(self, config: "Config", values: Dict[str, Any]):
         return config
 
-    @contextmanager
     def list(self, i: int):
-        yield i
+        return self.context.push(str(i))
 
-    @contextmanager
     def map(self, k: str):
-        yield k
+        return self.context.push(k)
 
     def __call__(self, x):
         if isinstance(x, Config):
@@ -426,18 +433,6 @@ class ConfigProcessing:
         raise NotImplementedError(f"Cannot handle a value of type {type(x)}")
 
 
-class GenerationConfigProcessing(ConfigProcessing):
-    def __init__(self, context: GenerationContext, recurse_task=False):
-        super().__init__(recurse_task=recurse_task)
-        self.context = context
-
-    def list(self, i: int):
-        return self.context.push(str(i))
-
-    def map(self, k: str):
-        return self.context.push(k)
-
-
 def getqualattr(module, qualname):
     """Get a qualified attributed value"""
     cls = module
@@ -464,6 +459,7 @@ class ConfigInformation:
         # Meta-informations
         self._tags = {}
         self._initinfo = ""
+        self.submit_hooks = set()
 
         # Generated task
         self._taskoutput = None
@@ -534,7 +530,7 @@ class ConfigInformation:
                 yield argument, self.values[argument.name]
 
     def tags(self):
-        class TagFinder(ConfigProcessing):
+        class TagFinder(ConfigWalk):
             def __init__(self):
                 super().__init__(recurse_task=True)
                 self.tags = {}
@@ -578,7 +574,7 @@ class ConfigInformation:
                     )
                     raise
 
-    def seal(self, context: GenerationContext):
+    def seal(self, context: ConfigWalkContext):
         """Seal the object, generating values when needed,
         before scheduling the associated job(s)
 
@@ -586,7 +582,7 @@ class ConfigInformation:
             - context: the generation context
         """
 
-        class Sealer(GenerationConfigProcessing):
+        class Sealer(ConfigWalk):
             def preprocess(self, config: Config):
                 return not config.__xpm__._sealed, config
 
@@ -607,9 +603,9 @@ class ConfigInformation:
 
         Internal API - do not use
         """
-        context = GenerationContext()
+        context = ConfigWalkContext()
 
-        class Unsealer(GenerationConfigProcessing):
+        class Unsealer(ConfigWalk):
             def preprocess(self, config: Config):
                 return config.__xpm__._sealed, config
 
@@ -658,6 +654,23 @@ class ConfigInformation:
                 logger.error("While setting %s", path + [argument.name])
                 raise
 
+    def apply_submit_hooks(self, job: "Job"):
+        """Apply configuration hooks"""
+        context = ConfigWalkContext()
+
+        class HookGatherer(ConfigWalk):
+            def __init__(self, *args, **kwargs):
+                super().__init__(*args, **kwargs)
+                self.hooks = set()
+
+            def postprocess(self, config: "Config", values: Dict[str, Any]):
+                self.hooks.update(config.__xpm__.submit_hooks)
+
+        gatherer = HookGatherer(context, recurse_task=False)
+        gatherer(self.pyobject)
+        for hook in gatherer.hooks:
+            hook(job)
+
     def submit(
         self, workspace: "Workspace", launcher: "Launcher", run_mode=None
     ) -> "TaskOutput":
@@ -696,7 +709,7 @@ class ConfigInformation:
             experiment.CURRENT.workspace if experiment.CURRENT else None
         )
 
-        # Call onSubmit
+        # Call onSubmit hooks
         launcher = (
             launcher
             or (workspace and workspace.launcher)
@@ -705,6 +718,9 @@ class ConfigInformation:
         if launcher:
             launcher.onSubmit(self.job)
 
+        # Apply submit hooks
+        self.apply_submit_hooks(self.job)
+
         # Add job dependencies
         self.updatedependencies(self.job.dependencies, [], set([id(self.pyobject)]))
 
@@ -1194,8 +1210,8 @@ class ConfigInformation:
 
         return o
 
-    class FromPython(GenerationConfigProcessing):
-        def __init__(self, context: GenerationContext):
+    class FromPython(ConfigWalk):
+        def __init__(self, context: ConfigWalkContext):
             super().__init__(context)
             self.objects = {}
 
@@ -1233,7 +1249,7 @@ class ConfigInformation:
 
             return o
 
-    def fromConfig(self, context: GenerationContext):
+    def fromConfig(self, context: ConfigWalkContext):
         """Generate an instance given the current configuration"""
         self.validate()
         processor = ConfigInformation.FromPython(context)
@@ -1378,7 +1394,7 @@ class TypeConfig:
         self.__xpm__.add_dependencies(*dependencies)
         return self
 
-    def instance(self, context: GenerationContext = None) -> T:
+    def instance(self, context: ConfigWalkContext = None) -> T:
         """Return an instance with the current values"""
         if context is None:
             from experimaestro.xpmutils import EmptyContext
@@ -1386,8 +1402,8 @@ class TypeConfig:
             context = EmptyContext()
         else:
             assert isinstance(
-                context, GenerationContext
-            ), f"{context.__class__} is not an instance of GenerationContext"
+                context, ConfigWalkContext
+            ), f"{context.__class__} is not an instance of ConfigWalkContext"
         return self.__xpm__.fromConfig(context)  # type: ignore
 
     def submit(self, *, workspace=None, launcher=None, run_mode: "RunMode" = None):
@@ -1434,7 +1450,7 @@ class Config:
     configuration/task"""
 
     @classmethod
-    def __getxpmtype__(cls):
+    def __getxpmtype__(cls) -> "ObjectType":
         """Get (and create if necessary) the Object type of this"""
         xpmtype = cls.__dict__.get("__xpmtype__", None)
         if xpmtype is None:

{experimaestro-0.21.0 → experimaestro-0.23.0}/src/experimaestro/core/objects.pyi

@@ -1,8 +1,10 @@
+from abc import ABC
 import typing_extensions
 
 from experimaestro.core.types import ObjectType
 import experimaestro
 import io
+from experimaestro.launchers import Launcher
 from experimaestro.scheduler.base import Job
 
 from experimaestro.scheduler.workspace import RunMode
@@ -20,7 +22,18 @@ from experimaestro.core.types import (
 from experimaestro.utils import logger as logger
 from functools import cached_property as cached_property
 from pathlib import Path
-from typing import Any, ClassVar, Dict, List, Optional, Set, TypeVar, Union, overload
+from typing import (
+    Any,
+    Callable,
+    ClassVar,
+    Dict,
+    List,
+    Optional,
+    Set,
+    TypeVar,
+    Union,
+    overload,
+)
 
 T = TypeVar("T", bound="Config")
 
@@ -62,7 +75,7 @@ class TaggedValue:
 
 def add_to_path(p) -> Generator[None, None, None]: ...
 
-class GenerationContext:
+class ConfigWalkContext:
     @property
     def path(self) -> None: ...
     def __init__(self) -> None: ...
@@ -83,9 +96,9 @@ class ConfigProcessing:
     def map(self, k: str): ...
     def __call__(self, x): ...
 
-class GenerationConfigProcessing(ConfigProcessing):
+class ConfigWalk(ConfigProcessing):
     context: Incomplete
-    def __init__(self, context: GenerationContext) -> None: ...
+    def __init__(self, context: ConfigWalkContext) -> None: ...
     def list(self, i: int): ...
     def map(self, k: str): ...
 
@@ -108,7 +121,7 @@ class ConfigInformation:
     def xpmvalues(self, generated: bool = ...) -> Generator[Incomplete, None, None]: ...
     def tags(self): ...
     def validate(self) -> None: ...
-    def seal(self, context: GenerationContext): ...
+    def seal(self, context: ConfigWalkContext): ...
     @property
     def identifier(self) -> Identifier: ...
     def dependency(self): ...
@@ -141,13 +154,13 @@ class ConfigInformation:
         save_directory: Optional[Path] = ...,
     ) -> Config: ...
 
-    class FromPython(GenerationConfigProcessing):
+    class FromPython(ConfigWalk):
         objects: Incomplete
-        def __init__(self, context: GenerationContext) -> None: ...
+        def __init__(self, context: ConfigWalkContext) -> None: ...
         def preprocess(self, config: Config): ...
         def postprocess(self, config: Config, values: Dict[str, Any]): ...
 
-    def fromConfig(self, context: GenerationContext): ...
+    def fromConfig(self, context: ConfigWalkContext): ...
     def add_dependencies(self, *dependencies) -> None: ...
 
 def clone(v): ...
@@ -162,7 +175,7 @@ class TypeConfig:
     def __arguments__(self): ...
     def tags(self): ...
     def add_dependencies(self, *dependencies): ...
-    def instance(self, context: GenerationContext = ...) -> T: ...
+    def instance(self, context: ConfigWalkContext = ...) -> T: ...
     def submit(
         self,
         *,
@@ -183,7 +196,7 @@ class Config:
     __xpmtype__: ClassVar[ObjectType]
     __xpm__: ConfigInformation
     @classmethod
-    def __getxpmtype__(cls): ...
+    def __getxpmtype__(cls) -> ObjectType: ...
     def __getnewargs_ex__(self): ...
     @classmethod
     def c(cls, **kwargs) -> T: ...