ml-dash 0.5.0__py3-none-any.whl → 0.5.1__py3-none-any.whl

ml_dash/client.py

@@ -35,6 +35,7 @@ class RemoteClient:
         name: str,
         description: Optional[str] = None,
         tags: Optional[List[str]] = None,
+        bindrs: Optional[List[str]] = None,
         folder: Optional[str] = None,
         write_protected: bool = False,
         metadata: Optional[Dict[str, Any]] = None,
@@ -47,6 +48,7 @@ class RemoteClient:
             name: Experiment name
             description: Optional description
             tags: Optional list of tags
+            bindrs: Optional list of bindrs
             folder: Optional folder path
             write_protected: If True, experiment becomes immutable
             metadata: Optional metadata dict
@@ -65,6 +67,8 @@ class RemoteClient:
             payload["description"] = description
         if tags is not None:
             payload["tags"] = tags
+        if bindrs is not None:
+            payload["bindrs"] = bindrs
         if folder is not None:
             payload["folder"] = folder
         if write_protected:
@@ -79,6 +83,35 @@ class RemoteClient:
         response.raise_for_status()
         return response.json()
 
+    def update_experiment_status(
+        self,
+        experiment_id: str,
+        status: str,
+    ) -> Dict[str, Any]:
+        """
+        Update experiment status.
+
+        Args:
+            experiment_id: Experiment ID
+            status: Status value - "RUNNING" | "COMPLETED" | "FAILED" | "CANCELLED"
+
+        Returns:
+            Response dict with updated experiment data
+
+        Raises:
+            httpx.HTTPStatusError: If request fails
+        """
+        payload = {
+            "status": status,
+        }
+
+        response = self._client.patch(
+            f"/experiments/{experiment_id}/status",
+            json=payload,
+        )
+        response.raise_for_status()
+        return response.json()
+
     def create_log_entries(
         self,
         experiment_id: str,

ml_dash/experiment.py

@@ -65,6 +65,7 @@ class Experiment:
         *,
         description: Optional[str] = None,
         tags: Optional[List[str]] = None,
+        bindrs: Optional[List[str]] = None,
         folder: Optional[str] = None,
         write_protected: bool = False,
         metadata: Optional[Dict[str, Any]] = None,
@@ -82,6 +83,7 @@ class Experiment:
             project: Project name
             description: Optional experiment description
             tags: Optional list of tags
+            bindrs: Optional list of bindrs
             folder: Optional folder path (e.g., "/experiments/baseline")
             write_protected: If True, experiment becomes immutable after creation
             metadata: Optional metadata dict
@@ -94,6 +96,7 @@ class Experiment:
         self.project = project
         self.description = description
         self.tags = tags
+        self.bindrs = bindrs
         self.folder = folder
         self.write_protected = write_protected
         self.metadata = metadata
@@ -185,6 +188,7 @@ class Experiment:
                 name=self.name,
                 description=self.description,
                 tags=self.tags,
+                bindrs=self.bindrs,
                 folder=self.folder,
                 write_protected=self.write_protected,
                 metadata=self.metadata,
@@ -199,6 +203,7 @@ class Experiment:
                 name=self.name,
                 description=self.description,
                 tags=self.tags,
+                bindrs=self.bindrs,
                 folder=self.folder,
                 metadata=self.metadata,
             )
@@ -206,8 +211,13 @@ class Experiment:
         self._is_open = True
         return self
 
-    def close(self):
-        """Close the experiment."""
+    def close(self, status: str = "COMPLETED"):
+        """
+        Close the experiment and update status.
+
+        Args:
+            status: Status to set - "COMPLETED" (default), "FAILED", or "CANCELLED"
+        """
         if not self._is_open:
             return
 
@@ -215,6 +225,17 @@ class Experiment:
         if self._storage:
             self._storage.flush()
 
+        # Update experiment status in remote mode
+        if self._client and self._experiment_id:
+            try:
+                self._client.update_experiment_status(
+                    experiment_id=self._experiment_id,
+                    status=status
+                )
+            except Exception as e:
+                # Log error but don't fail the close operation
+                print(f"Warning: Failed to update experiment status: {e}")
+
         self._is_open = False
 
     def __enter__(self) -> "Experiment":
@@ -222,8 +243,10 @@ class Experiment:
         return self.open()
 
     def __exit__(self, exc_type, exc_val, exc_tb):
-        """Context manager exit."""
-        self.close()
+        """Context manager exit. Sets status to FAILED if exception occurred."""
+        # Determine status based on whether an exception occurred
+        status = "FAILED" if exc_type is not None else "COMPLETED"
+        self.close(status=status)
         return False
 
     def log(

ml_dash/storage.py

@@ -43,6 +43,7 @@ class LocalStorage:
         name: str,
         description: Optional[str] = None,
         tags: Optional[List[str]] = None,
+        bindrs: Optional[List[str]] = None,
         folder: Optional[str] = None,
         metadata: Optional[Dict[str, Any]] = None,
     ) -> Path:
@@ -54,6 +55,7 @@ class LocalStorage:
             name: Experiment name
             description: Optional description
             tags: Optional tags
+            bindrs: Optional bindrs
             folder: Optional folder path (used for organization)
             metadata: Optional metadata
 
@@ -79,6 +81,7 @@ class LocalStorage:
             "project": project,
             "description": description,
             "tags": tags or [],
+            "bindrs": bindrs or [],
             "folder": folder,
             "metadata": metadata,
             "created_at": datetime.utcnow().isoformat() + "Z",
@@ -99,6 +102,8 @@ class LocalStorage:
                 existing["description"] = description
             if tags is not None:
                 existing["tags"] = tags
+            if bindrs is not None:
+                existing["bindrs"] = bindrs
             if folder is not None:
                 existing["folder"] = folder
             if metadata is not None:
@@ -288,7 +293,7 @@ class LocalStorage:
         """
         Write file to local storage.
 
-        Copies file to: files/<file_id>/<filename>
+        Copies file to: files/<prefix>/<file_id>/<filename>
         Updates .files_metadata.json with file metadata
 
         Args:
@@ -317,8 +322,14 @@ class LocalStorage:
         # Generate Snowflake ID for file
         file_id = generate_snowflake_id()
 
-        # Create file directory
-        file_dir = files_dir / file_id
+        # Normalize prefix (remove leading slashes to avoid absolute paths)
+        normalized_prefix = prefix.lstrip("/") if prefix else ""
+
+        # Create prefix directory, then file directory
+        prefix_dir = files_dir / normalized_prefix if normalized_prefix else files_dir
+        prefix_dir.mkdir(parents=True, exist_ok=True)
+
+        file_dir = prefix_dir / file_id
         file_dir.mkdir(parents=True, exist_ok=True)
 
         # Copy file
@@ -363,7 +374,11 @@ class LocalStorage:
         if existing_index is not None:
             # Overwrite: remove old file and update metadata
             old_file = files_metadata["files"][existing_index]
-            old_file_dir = files_dir / old_file["id"]
+            old_prefix = old_file["path"].lstrip("/") if old_file["path"] else ""
+            if old_prefix:
+                old_file_dir = files_dir / old_prefix / old_file["id"]
+            else:
+                old_file_dir = files_dir / old_file["id"]
             if old_file_dir.exists():
                 shutil.rmtree(old_file_dir)
             files_metadata["files"][existing_index] = file_metadata
@@ -470,7 +485,11 @@ class LocalStorage:
             raise FileNotFoundError(f"File {file_id} not found")
 
         # Get source file
-        source_file = files_dir / file_id / file_metadata["filename"]
+        file_prefix = file_metadata["path"].lstrip("/") if file_metadata["path"] else ""
+        if file_prefix:
+            source_file = files_dir / file_prefix / file_id / file_metadata["filename"]
+        else:
+            source_file = files_dir / file_id / file_metadata["filename"]
         if not source_file.exists():
             raise FileNotFoundError(f"File {file_id} not found on disk")
 

{ml_dash-0.5.0.dist-info → ml_dash-0.5.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ml-dash
-Version: 0.5.0
+Version: 0.5.1
 Summary: ML experiment metricing and data storage
 Keywords: machine-learning,experiment-metricing,mlops,data-storage
 Author: Ge Yang, Tom Tao
@@ -67,6 +67,9 @@ A simple and flexible SDK for ML experiment metricing and data storage.
 - **Dual Operation Modes**: Remote (API server) or local (filesystem)
 - **Auto-creation**: Automatically creates namespace, project, and folder hierarchy
 - **Upsert Behavior**: Updates existing experiments or creates new ones
+- **Experiment Lifecycle**: Automatic status tracking (RUNNING, COMPLETED, FAILED, CANCELLED)
+- **Organized File Storage**: Prefix-based file organization with unique snowflake IDs
+- **Rich Metadata**: Tags, bindrs, descriptions, and custom metadata support
 - **Simple API**: Minimal configuration, maximum flexibility
 
 ## Installation

{ml_dash-0.5.0.dist-info → ml_dash-0.5.1.dist-info}/RECORD

@@ -1,12 +1,12 @@
 ml_dash/__init__.py,sha256=5tT0Lmf0SS3J7BOwJGVai8FOjdpjKGBJCEYL5nXnkLA,1384
-ml_dash/client.py,sha256=1T85L-YOCVRakzZlKCKaW6-kSDpo8gx_pdG8wvvi9Tc,16391
-ml_dash/experiment.py,sha256=MKQsEs1MQ07xbPHvWRvatyvLOXuiDKxJx7QWPfpmygM,27658
+ml_dash/client.py,sha256=vhWcS5o2n3o4apEjVeLmu7flCEzxBbBOoLSQNcAx_ew,17267
+ml_dash/experiment.py,sha256=x1jtQD1QroNjNULOxZiGtX5oFLi3ZXDaFbGHWt0yMJU,28652
 ml_dash/files.py,sha256=WKWbcug6XADwZruYQio1EdSstmfTsty9-2-t2KPWz38,9719
 ml_dash/log.py,sha256=0yXaNnFwYeBI3tRLHX3kkqWRpg0MbSGwmgjnOfsElCk,5350
 ml_dash/metric.py,sha256=PcEd6_HTLDpf-kBIDeQq2LlTRAS7xDx6EvSBpin5iuY,6456
 ml_dash/params.py,sha256=W-JkY1Mz7KdmvDjQ0HFV2QnpBov7Gf4dl70fuBnXTdo,5974
 ml_dash/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ml_dash/storage.py,sha256=iVGPgRJnsUzxfTh12QCUKyPC-SiK4QNDWHsUBLxP0I0,29538
-ml_dash-0.5.0.dist-info/WHEEL,sha256=X16MKk8bp2DRsAuyteHJ-9qOjzmnY0x1aj0P1ftqqWA,78
-ml_dash-0.5.0.dist-info/METADATA,sha256=j1GGNmDvmp8REzN8AIsdiLRimiZqPz7OuEpAhf71Kys,5809
-ml_dash-0.5.0.dist-info/RECORD,,
+ml_dash/storage.py,sha256=UTuux2nfclLrrtlkC6TsOvDB_wIbSDvYGg8Gtbvk6mc,30471
+ml_dash-0.5.1.dist-info/WHEEL,sha256=X16MKk8bp2DRsAuyteHJ-9qOjzmnY0x1aj0P1ftqqWA,78
+ml_dash-0.5.1.dist-info/METADATA,sha256=TBTqi4lJNoFO2eyztYJZptQypUSVTDVUdbGS0EnQZ2k,6067
+ml_dash-0.5.1.dist-info/RECORD,,