experimaestro 1.4.0__tar.gz → 1.4.2__tar.gz

{experimaestro-1.4.0 → experimaestro-1.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: experimaestro
-Version: 1.4.0
+Version: 1.4.2
 Summary: "Experimaestro is a computer science experiment manager"
 Home-page: https://github.com/experimaestro/experimaestro-python
 License: GPL-3
@@ -53,16 +53,19 @@ Project-URL: Repository, https://github.com/experimaestro/experimaestro-python
 Description-Content-Type: text/markdown
 
 [![PyPI version](https://badge.fury.io/py/experimaestro.svg)](https://badge.fury.io/py/experimaestro)
+[![RTD](https://readthedocs.org/projects/experimaestro-python/badge/?version=latest)](https://experimaestro-python.readthedocs.io)
 
-Experimaestro is a computer science experiment manager whose goals are:
+Experimaestro helps in designing and managing complex workflows. It allows for the definition of tasks and their dependencies, ensuring that each step in a workflow is executed in the correct order. Some key aspects of Experimaestro are:
 
-- To decompose experiments into a set of parameterizable tasks
-- Schedule tasks and handle dependencies between tasks
-- Avoids to re-run the same task two times by computing unique task IDs dependending on the parameters
-- Handle experimental parameters through tags
+- **Task Automation**: The tool automates repetitive tasks, making it easier to run large-scale experiments. It's particularly useful in scenarios where experiments need to be repeated with different parameters or datasets.
+- **Resource Management**: It efficiently manages computational resources, which is critical when dealing with data-intensive tasks or when running multiple experiments in parallel.
+- **Extensibility**: Experimaestro is designed to be flexible and extensible, allowing users to integrate it with various programming languages and tools commonly used in data science and research.
+- **Reproducibility**: By keeping a detailed record of experiments, including parameters and environments, it aids in ensuring the reproducibility of scientific experiments, which is a fundamental requirement in research.
+- **User Interface**: While primarily a back-end tool, Experimaestro also offers a user interface to help in managing and visualizing workflows.
 
 The full documentation can be read by going to the following URL: [https://experimaestro-python.readthedocs.io](https://experimaestro-python.readthedocs.io)
 
+
 # Install
 
 ## With pip

{experimaestro-1.4.0 → experimaestro-1.4.2}/README.md

@@ -1,14 +1,17 @@
 [![PyPI version](https://badge.fury.io/py/experimaestro.svg)](https://badge.fury.io/py/experimaestro)
+[![RTD](https://readthedocs.org/projects/experimaestro-python/badge/?version=latest)](https://experimaestro-python.readthedocs.io)
 
-Experimaestro is a computer science experiment manager whose goals are:
+Experimaestro helps in designing and managing complex workflows. It allows for the definition of tasks and their dependencies, ensuring that each step in a workflow is executed in the correct order. Some key aspects of Experimaestro are:
 
-- To decompose experiments into a set of parameterizable tasks
-- Schedule tasks and handle dependencies between tasks
-- Avoids to re-run the same task two times by computing unique task IDs dependending on the parameters
-- Handle experimental parameters through tags
+- **Task Automation**: The tool automates repetitive tasks, making it easier to run large-scale experiments. It's particularly useful in scenarios where experiments need to be repeated with different parameters or datasets.
+- **Resource Management**: It efficiently manages computational resources, which is critical when dealing with data-intensive tasks or when running multiple experiments in parallel.
+- **Extensibility**: Experimaestro is designed to be flexible and extensible, allowing users to integrate it with various programming languages and tools commonly used in data science and research.
+- **Reproducibility**: By keeping a detailed record of experiments, including parameters and environments, it aids in ensuring the reproducibility of scientific experiments, which is a fundamental requirement in research.
+- **User Interface**: While primarily a back-end tool, Experimaestro also offers a user interface to help in managing and visualizing workflows.
 
 The full documentation can be read by going to the following URL: [https://experimaestro-python.readthedocs.io](https://experimaestro-python.readthedocs.io)
 
+
 # Install
 
 ## With pip

{experimaestro-1.4.0 → experimaestro-1.4.2}/pyproject.toml

@@ -19,7 +19,7 @@ include = [
     "src/experimaestro/sphinx/static/experimaestro.css",
     "src/experimaestro/mkdocs/style.css"
 ]
-version = "1.4.0"
+version = "1.4.2"
 repository = "https://github.com/experimaestro/experimaestro-python"
 documentation = "https://experimaestro-python.readthedocs.io/"
 
@@ -124,7 +124,7 @@ warn_unused_ignores = true
 
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "1.4.0"
+version = "1.4.2"
 changelog_start_rev = "0.15.0"
 tag_format = "v$version"
 update_changelog_on_bump = true

{experimaestro-1.4.0 → experimaestro-1.4.2}/src/experimaestro/__init__.py

@@ -27,7 +27,7 @@ from .annotations import (
     # Method
     config_only,
 )
-from .core.serialization import load, save, state_dict, from_state_dict
+from .core.serialization import load, save, state_dict, from_state_dict, from_task_dir
 from .core.arguments import (
     # Types
     Param,

{experimaestro-1.4.0 → experimaestro-1.4.2}/src/experimaestro/core/objects.py

@@ -76,6 +76,9 @@ class Identifier:
 
         return Identifier(bytes.fromhex(data["main"]))
 
+    def __repr__(self):
+        return self.main.hex()
+
 
 def is_ignored(value):
     """Returns True if the value should be ignored by itself"""

{experimaestro-1.4.0 → experimaestro-1.4.2}/src/experimaestro/core/serialization.py

@@ -112,3 +112,17 @@ def load(
     with data_loader("definition.json").open("rt") as fh:
         content = json.load(fh)
     return from_state_dict(content, as_instance=as_instance)
+
+
+def from_task_dir(
+    path: Union[str, Path, SerializedPathLoader],
+    as_instance: bool = False,
+):
+    """Loads a task object"""
+    data_loader = get_data_loader(path)
+    with data_loader("params.json").open("rt") as fh:
+        content = json.load(fh)
+
+    content["data"] = {"type": "python", "value": content["objects"][-1]["id"]}
+
+    return from_state_dict(content, as_instance=as_instance)

{experimaestro-1.4.0 → experimaestro-1.4.2}/src/experimaestro/core/utils.py

@@ -10,7 +10,7 @@ class TaskSequence(Task):
 
     @property
     def __identifier__(self):
-        return self.tasks[-1].__identifier__
+        return self.tasks[-1].__identifier__()
 
     def execute(self):
         self.tasks[-1].__tags__ = self.__tags__

{experimaestro-1.4.0 → experimaestro-1.4.2}/src/experimaestro/experiments/cli.py

@@ -33,6 +33,17 @@ class ExperimentHelper:
         assert len(args) == 0
         self.callable(self, configuration)
 
+    @classmethod
+    def decorator(cls, *args, **kwargs):
+        """Decorator for the run(helper, configuration) method"""
+        if len(args) == 1 and len(kwargs) == 0 and inspect.isfunction(args[0]):
+            return cls(callable)
+
+        def wrapper(callable):
+            return cls(callable)
+
+        return wrapper
+
 
 class ExperimentCallable(Protocol):
     """Protocol for the run function"""

{experimaestro-1.4.0 → experimaestro-1.4.2}/src/experimaestro/experiments/configuration.py

@@ -28,5 +28,5 @@ class ConfigurationBase:
     file: str = "experiment"
     """qualified name (relative to the module) for the file containing a run function"""
 
-    parent: Optional[str]
+    parent: Optional[str] = None
     """Relative path of a YAML file that should be merged"""

{experimaestro-1.4.0 → experimaestro-1.4.2}/src/experimaestro/scheduler/base.py

@@ -953,7 +953,6 @@ class 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