experimaestro 1.4.0__py3-none-any.whl → 1.4.2__py3-none-any.whl

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/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/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/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/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/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/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

{experimaestro-1.4.0.dist-info → experimaestro-1.4.2.dist-info}/METADATA

@@ -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.dist-info → experimaestro-1.4.2.dist-info}/RECORD

@@ -1,4 +1,4 @@
-experimaestro/__init__.py,sha256=TURptLVx9XunBd01lO4TYZACrP5rnMRnh_XE0T0_MwQ,1533
+experimaestro/__init__.py,sha256=5T8NC2WvqlCRXV4qSW4-_V42owXQs_YpXbEP6vLZN7E,1548
 experimaestro/__main__.py,sha256=iRi6yRJVcthXRTVnHQB0TNOKTRmKjdnX6yIQaf-z79o,13528
 experimaestro/annotations.py,sha256=dcpFmo01T12S_y5nIBIQjiXsGsq5S80ZB-58o8tW9wA,8450
 experimaestro/checkers.py,sha256=ZCMbnE_GFC5compWjt-fuHhPImi9fCPjImF8Ow9NqK8,696
@@ -11,15 +11,15 @@ experimaestro/connectors/ssh.py,sha256=A6qObY_phynZVQFdAsyymP9c0fiUHwn04nShROzMr
 experimaestro/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 experimaestro/core/arguments.py,sha256=dW32opqNEsULYr6nR7Zk8PqHsSCbLPclfXofw27GTpI,5620
 experimaestro/core/context.py,sha256=Q8_ngiHRBZ0laavXRJNiDvdCprrnROVTWaHfrwMdlG4,2638
-experimaestro/core/objects.py,sha256=AuviYnITYuoKkj2MR6ovyU7cMl8BgJfXp5yAKaunlJo,62571
+experimaestro/core/objects.py,sha256=UeQJmJ4597T89mjxNauGbnnfeiPkG4ifmoZuKDoi2Ds,62627
 experimaestro/core/objects.pyi,sha256=D8-kd-NU-pRl9-_ktXUne_k1YH6TG3VGqRaKV8mrZwk,7003
-experimaestro/core/serialization.py,sha256=nLlSSqerH9lqiWvqkCxz0YRRW8M1y56ainZ9_GVgTMk,3432
+experimaestro/core/serialization.py,sha256=9tg5ebLF3YeZ_zG9DiTHPLthppvo7io710ohD_dcLTo,3836
 experimaestro/core/serializers.py,sha256=R_CAMyjjfU1oi-eHU6VlEUixJpFayGqEPaYu7VsD9xA,1197
 experimaestro/core/types.py,sha256=jQGlyC1xnsZ5NKct3FELIcXcXQMvNQvauCEuumyfBz8,19253
-experimaestro/core/utils.py,sha256=jKmZqovj5BhmWQ0rXd3YFToSbIFTylC48NhCwxo3QfU,493
+experimaestro/core/utils.py,sha256=JfC3qGUS9b6FUHc2VxIYUI9ysNpXSQ1LjOBkjfZ8n7o,495
 experimaestro/experiments/__init__.py,sha256=GcpDUIbCvhnv6rxFdAp4wTffCVNTv-InY6fbQAlTy-o,159
-experimaestro/experiments/cli.py,sha256=QJ04wB0O3O0X0SEHM-Y8peA74lE1WIDesbk9_RsghL0,6216
-experimaestro/experiments/configuration.py,sha256=bwoszuFWFT2fmaL7RNefNschBGpydDQkSgcSmLJ8gek,787
+experimaestro/experiments/cli.py,sha256=ftAo8Km0WM_CuooBvFMZXhNgTtisGkLajEPDWlTF3cg,6543
+experimaestro/experiments/configuration.py,sha256=xdDzoLSN3m2bOdvYuWisLzOi_Bno4zGOQydi5q3IcHk,794
 experimaestro/filter.py,sha256=DN1PrmS9yXoOa5Xnv001zbxzpdzvcVZFI9xZFKZ1-6g,5794
 experimaestro/generators.py,sha256=9NQ_TfDfASkArLnO4PF7s5Yoo9KWjlna2DCPzk5gJOI,1230
 experimaestro/huggingface.py,sha256=gnVlr6SZnbutYz4PLH0Q77n1TRF-uk-dR-3UFzFqAY0,2956
@@ -48,7 +48,7 @@ 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=B4L3E-TnNjt0kutaEVrnA3-rTpoCfuXZO9rzH28phNI,30945
+experimaestro/scheduler/base.py,sha256=l-DPZJQMNHr-pbUwfLJbGS7Wp9jX1m9I9cLwdS5xbZ8,30914
 experimaestro/scheduler/dependencies.py,sha256=n9XegwrmjayOIxt3xhuTEBVEBGSq4oeVdzz-FviDGXo,1994
 experimaestro/scheduler/environment.py,sha256=ZaSHSgAcZBmIj7b_eS1OvNQOuVLFvuw-qvqtYrc3Vms,2393
 experimaestro/scheduler/services.py,sha256=aCKkNZMULlceabqf-kOs_-C7KPINnjU3Q-I00o5x6iY,2189
@@ -140,8 +140,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.4.0.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-experimaestro-1.4.0.dist-info/METADATA,sha256=XWQCmuYMI4mGENdtGlEA7p0D4enym4BV3laNFmW8Kc0,5336
-experimaestro-1.4.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-experimaestro-1.4.0.dist-info/entry_points.txt,sha256=PhaEili_fDgn5q7rBJGip_uhGkRBq5l3Yuhg91zkcbk,574
-experimaestro-1.4.0.dist-info/RECORD,,
+experimaestro-1.4.2.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+experimaestro-1.4.2.dist-info/METADATA,sha256=zETYgTyjliPNfJlhX6yDfX0y9cldKWZyREc6kJcslxM,6338
+experimaestro-1.4.2.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+experimaestro-1.4.2.dist-info/entry_points.txt,sha256=PhaEili_fDgn5q7rBJGip_uhGkRBq5l3Yuhg91zkcbk,574
+experimaestro-1.4.2.dist-info/RECORD,,