ml-dash 0.6.4__py3-none-any.whl → 0.6.6__py3-none-any.whl

ml_dash/run.py

@@ -22,14 +22,43 @@ Usage:
         exp.logs.info(f"Running {RUN.name}")
 """
 
+import functools
 import os
 import sys
+import typing
 from datetime import datetime
 from pathlib import Path
-from typing import Union
+from typing import Optional, Union
 
 from params_proto import EnvVar, proto
 
+
+def requires_open(func):
+  """
+  Decorator that ensures the experiment is open before executing a method.
+
+  Raises:
+      RuntimeError: If experiment is not started
+  """
+
+  @functools.wraps(func)
+  def wrapper(self, *args, **kwargs):
+    if not self._is_open:
+      raise RuntimeError(
+        "Experiment not started. Use 'with experiment.run:' or call experiment.run.start() first.\n"
+        "Example:\n"
+        "  with dxp.run:\n"
+        "      dxp.params.set(lr=0.001)"
+      )
+    return func(self, *args, **kwargs)
+
+  return wrapper
+
+if typing.TYPE_CHECKING:
+  from .client import RemoteClient
+  from .experiment import Experiment
+  from .storage import LocalStorage
+
 PROJECT_ROOT_FILES = ("pyproject.toml", "requirements.txt", "setup.py", "setup.cfg")
 
 
@@ -77,12 +106,19 @@ def find_project_root(
 @proto.prefix
 class RUN:
   """
-  Global Experiment Run Configuration.
+  Global Experiment Run Configuration and
+  Lifecycle manager for experiments
 
   This class is the single source of truth for experiment metadata.
   Configure it before starting an experiment, or through the Experiment
   constructor.
 
+  Supports three usage patterns:
+  1. Method calls: experiment.run.start(), experiment.run.complete()
+  2. Context manager: with Experiment(...).run as exp:
+      3. Decorator: @exp.run or @Experiment(...).run
+
+
   Default prefix template:
       {project}/{now:%Y/%m-%d}/{path_stem}/{job_name}
 
@@ -156,10 +192,21 @@ class RUN:
   debug = "pydevd" in sys.modules
   "set to True automatically for pyCharm"
 
+  _experiment: "Experiment" = None
+  _client: Optional["RemoteClient"] = None
+  _storage: Optional["LocalStorage"] = None
+
+  # Prefix components (parsed from prefix)
+  owner: Optional[str] = None
+  name: Optional[str] = None
+  _folder_path: Optional[str] = None
+
   def __post_init__(self):
     """
+
     Initialize RUN with auto-detected prefix from entry path.
 
+
     Args:
         entry: Path to entry file/directory (e.g., __file__ or directory
                containing sweep.jsonl). If not provided, uses caller's
@@ -179,7 +226,6 @@ class RUN:
         RUN.__post_init__(entry=__file__)
         # Result: RUN.prefix = "vision/resnet", RUN.name = "resnet"
     """
-
     # Use provided entry or try to auto-detect from caller
     if self.entry is None:
       import inspect
@@ -221,6 +267,49 @@ class RUN:
     # for k, v in data.items():
     #   print(f"> {k:>30}: {v}")
 
+    # Parse prefix into components: {owner}/{project}/path.../[name]
+    if self.prefix:
+      self._folder_path = self.prefix
+      parts = self.prefix.strip("/").split("/")
+      if len(parts) >= 2:
+        self.owner = parts[0]
+        self.project = parts[1]
+        # self.name is the last segment
+        self.name = parts[-1] if len(parts) > 2 else parts[1]
+
+  def start(self) -> "Experiment":
+    """
+    Start the experiment (sets status to RUNNING).
+
+    Returns:
+        The experiment instance for chaining
+    """
+    return self._experiment._open()
+
+  def complete(self) -> None:
+    """Mark experiment as completed (status: COMPLETED)."""
+    self._experiment._close(status="COMPLETED")
+
+  def fail(self) -> None:
+    """Mark experiment as failed (status: FAILED)."""
+    self._experiment._close(status="FAILED")
+
+  def cancel(self) -> None:
+    """Mark experiment as cancelled (status: CANCELLED)."""
+    self._experiment._close(status="CANCELLED")
+
+  def __enter__(self) -> "Experiment":
+    """Context manager entry - starts the experiment."""
+    return self.start()
+
+  def __exit__(self, exc_type, exc_val, exc_tb):
+    """Context manager exit - completes or fails the experiment."""
+    if exc_type is not None:
+      self.fail()
+    else:
+      self.complete()
+    return False
+
 
 if __name__ == "__main__":
   RUN.description = ""

ml_dash/storage.py

@@ -84,7 +84,6 @@ class LocalStorage:
 
   def create_experiment(
     self,
-    owner: str,
     project: str,
     prefix: str,
     description: Optional[str] = None,
@@ -99,7 +98,6 @@ class LocalStorage:
     where prefix = owner/project/folder_1/.../exp_name
 
     Args:
-        owner: Owner/user (extracted from prefix, kept for API compatibility)
         project: Project name (extracted from prefix, kept for API compatibility)
         prefix: Full experiment path (owner/project/folder_1/.../exp_name)
         description: Optional description

{ml_dash-0.6.4.dist-info → ml_dash-0.6.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ml-dash
-Version: 0.6.4
+Version: 0.6.6
 Summary: ML experiment tracking and data storage
 Keywords: machine-learning,experiment-tracking,mlops,data-storage
 Author: Ge Yang, Tom Tao

{ml_dash-0.6.4.dist-info → ml_dash-0.6.6.dist-info}/RECORD

@@ -1,33 +1,34 @@
-ml_dash/__init__.py,sha256=XJym_-vgqFVwyAD-VsPZF9WWepTZ4w-Lwui5ns1gmJI,1583
+ml_dash/__init__.py,sha256=B1oYUXt2DnCctz5nWEqkg1M_XtbJNxaOPxbg54C0Vdc,1555
 ml_dash/auth/__init__.py,sha256=3lwM-Y8UBHPU1gFW2JNpmXlPVTnkGudWLKNFFKulQfo,1200
 ml_dash/auth/constants.py,sha256=ku4QzQUMNjvyJwjy7AUdywMAZd59jXSxNHZxDiagUWU,280
 ml_dash/auth/device_flow.py,sha256=DQOdPNlZCuU1umZOA_A6WXdRM3zWphnyo9IntToBl_A,7921
 ml_dash/auth/device_secret.py,sha256=qUsz6M9S1GEIukvmz57eJEp57srSx74O4MU9mZEeDlE,1158
 ml_dash/auth/exceptions.py,sha256=IeBwUzoaTyFtPwd4quFOIel49inIzuabe_ChEeEXEWI,725
 ml_dash/auth/token_storage.py,sha256=L18W8J7D1LlCDlY3Q32l0RXeNh0o7YVDQeeGYm64Dgw,8163
-ml_dash/auto_start.py,sha256=62_eZG1qBNAwu6AXduTSo4niCVZ27X52ZK0WEr3yS1o,1812
-ml_dash/cli.py,sha256=BoaBulcqnM88XuV5BQEx_-AQAXJAYSJqpvnHggEII_I,2559
+ml_dash/auto_start.py,sha256=FHTTui33bxfk5rHf-VY2RFcd2JQ_LsNpkUu7Qtpc-GY,1721
+ml_dash/cli.py,sha256=X8LsQA8Wfa1XuXsbvePaGo6NYer7f8CNzy33VT3jrqg,2740
 ml_dash/cli_commands/__init__.py,sha256=bjAmV7MsW-bhtW_4SnLJ0Cfkt9h82vMDC8ebW1Ke8KE,38
 ml_dash/cli_commands/api.py,sha256=NekZEJGWNpIfB6YrsrOw7kw7rZKjVudwgJWPZIy6ANQ,4535
+ml_dash/cli_commands/create.py,sha256=i6LPA6vefpHUeXncBNzQsLnwF5EM2uF6IX4g7vTDYXo,4400
 ml_dash/cli_commands/download.py,sha256=LeZXjQSEPIxZALuo90fj8RHjFWIbtGPE0F625sD3cU8,28054
 ml_dash/cli_commands/list.py,sha256=oc_yJXFhsvGgr3JedG2j7747yX69Qc546geIi4DQ54k,16129
 ml_dash/cli_commands/login.py,sha256=zX-urtUrfzg2qOGtKNYQgj6UloN9kzj4zEO6h_xwuNs,6782
 ml_dash/cli_commands/logout.py,sha256=lTUUNyRXqvo61qNkCd4KBrPUujDAHnNqsHkU6bHie0U,1332
 ml_dash/cli_commands/profile.py,sha256=BaSM6BAN3YM4tw95iKV_nypKZxwsB3PoAAejQcYip5E,2351
-ml_dash/cli_commands/upload.py,sha256=_607CcGjvjnwTgGzyxHaDG0qDAlSLlpZDoq6Sy-3paQ,44828
-ml_dash/client.py,sha256=kuLOJcBifgyBKQwQpI3jTvPlaUinJu_fCXROfGE3zGk,38328
+ml_dash/cli_commands/upload.py,sha256=1kTmnw4hAevl5mtB1GKlzEh2sPoudv0LTUNhCg0dIXs,45459
+ml_dash/client.py,sha256=VYOW-JNtHEonHoeS7InbyMXKRSrWFcRjo7onhqkGXKg,54659
 ml_dash/config.py,sha256=oz2xvoBh2X_xUXWr92cPD5nFxXMT5LxVNypv5B5O0fA,3116
-ml_dash/experiment.py,sha256=1uDCKNDlgGkKoogao3sEFz1sUhmiRvX3ZPGoQ7H3ozE,41361
+ml_dash/experiment.py,sha256=JCLSWJMOSHQ-dAfR4hOwB07BpNoXzbWTY9lk4VOVRKY,37678
 ml_dash/files.py,sha256=bihUHKpdknytLGuGgkcvhh585nziZrvYjiHl6rHnoD0,49227
 ml_dash/log.py,sha256=E-DLg0vejVLLEyShJ_r0LneDMI0XU7XTH5iKWYJe9jI,5298
 ml_dash/metric.py,sha256=ghD1jnuv6dbjV1Jlo7q0mx9UEzpdto2Y1-oDWrSfg04,25809
 ml_dash/params.py,sha256=pPFvknJAJX5uhckzjO1r-HNnKbQFFKDISFmOXNET5eY,9046
 ml_dash/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ml_dash/remote_auto_start.py,sha256=5fvQDHv1CWEKFb6WAa5_uyEInwV_SvotXjOO_6i6ZKE,1687
-ml_dash/run.py,sha256=C0quTLZXKDAlwstzEiJ75CWCX1pwYrmtMZH3z-ia6Pw,6310
+ml_dash/run.py,sha256=_a1l5qswwMgrhvajx_lI-I5IXhfHDeH3hfLAJ7Uk_Gs,8847
 ml_dash/snowflake.py,sha256=14rEpRU5YltsmmmZW0EMUy_hdv5S5ME9gWVtmdmwfiU,4917
-ml_dash/storage.py,sha256=9mG42pvvWkkracbjCr9Xdp890Nm4XSxL7_JeFbBe28g,33020
-ml_dash-0.6.4.dist-info/WHEEL,sha256=z-mOpxbJHqy3cq6SvUThBZdaLGFZzdZPtgWLcP2NKjQ,79
-ml_dash-0.6.4.dist-info/entry_points.txt,sha256=dYs2EHX1uRNO7AQGNnVaJJpgiy0Z9q7tiy4fHSyaf3Q,46
-ml_dash-0.6.4.dist-info/METADATA,sha256=KB2IyFCHFl4pMG9CR7k4UWQb6EzSRAsN3ZZ-OPTg2hA,7203
-ml_dash-0.6.4.dist-info/RECORD,,
+ml_dash/storage.py,sha256=jJ0mYCeBIMQ_dQeNLaCiW0fndsliG68w-TmCI1HyYZc,32926
+ml_dash-0.6.6.dist-info/WHEEL,sha256=z-mOpxbJHqy3cq6SvUThBZdaLGFZzdZPtgWLcP2NKjQ,79
+ml_dash-0.6.6.dist-info/entry_points.txt,sha256=dYs2EHX1uRNO7AQGNnVaJJpgiy0Z9q7tiy4fHSyaf3Q,46
+ml_dash-0.6.6.dist-info/METADATA,sha256=ARlHyG-ZdMBqW-WSJjjaKuqwo2bm2M5X7ENkZ-yI0Z0,7203
+ml_dash-0.6.6.dist-info/RECORD,,