ml-dash 0.5.3__tar.gz → 0.5.5__tar.gz

{ml_dash-0.5.3 → ml_dash-0.5.5}/PKG-INFO

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

{ml_dash-0.5.3 → ml_dash-0.5.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ml-dash"
-version = "0.5.3"
+version = "0.5.5"
 description = "ML experiment tracking and data storage"
 readme = "README.md"
 requires-python = ">=3.9"

{ml_dash-0.5.3 → ml_dash-0.5.5}/src/ml_dash/experiment.py

@@ -460,7 +460,7 @@ class Experiment:
                 timestamp=log_entry["timestamp"]
             )
 
-    def file(self, **kwargs) -> FileBuilder:
+    def files(self, **kwargs) -> FileBuilder:
         """
         Get a FileBuilder for fluent file operations.
 
@@ -472,17 +472,17 @@ class Experiment:
 
         Examples:
             # Upload file
-            experiment.file(file_path="./model.pt", prefix="/models").save()
+            experiment.files(file_path="./model.pt", prefix="/models").save()
 
             # List files
-            files = experiment.file().list()
-            files = experiment.file(prefix="/models").list()
+            files = experiment.files().list()
+            files = experiment.files(prefix="/models").list()
 
             # Download file
-            experiment.file(file_id="123").download()
+            experiment.files(file_id="123").download()
 
             # Delete file
-            experiment.file(file_id="123").delete()
+            experiment.files(file_id="123").delete()
         """
         if not self._is_open:
             raise RuntimeError("Experiment not open. Use experiment.open() or context manager.")
@@ -791,7 +791,7 @@ class Experiment:
 
     def _append_to_metric(
         self,
-        name: str,
+        name: Optional[str],
         data: Dict[str, Any],
         description: Optional[str],
         tags: Optional[List[str]],
@@ -801,7 +801,7 @@ class Experiment:
         Internal method to append a single data point to a metric.
 
         Args:
-            name: Metric name
+            name: Metric name (can be None for unnamed metrics)
             data: Data point (flexible schema)
             description: Optional metric description
             tags: Optional tags
@@ -839,7 +839,7 @@ class Experiment:
 
     def _append_batch_to_metric(
         self,
-        name: str,
+        name: Optional[str],
         data_points: List[Dict[str, Any]],
         description: Optional[str],
         tags: Optional[List[str]],
@@ -849,7 +849,7 @@ class Experiment:
         Internal method to append multiple data points to a metric.
 
         Args:
-            name: Metric name
+            name: Metric name (can be None for unnamed metrics)
             data_points: List of data points
             description: Optional metric description
             tags: Optional tags

{ml_dash-0.5.3 → ml_dash-0.5.5}/src/ml_dash/files.py

@@ -19,18 +19,18 @@ class FileBuilder:
 
     Usage:
         # Upload file
-        experiment.file(file_path="./model.pt", prefix="/models").save()
+        experiment.files(file_path="./model.pt", prefix="/models").save()
 
         # List files
-        files = experiment.file().list()
-        files = experiment.file(prefix="/models").list()
+        files = experiment.files().list()
+        files = experiment.files(prefix="/models").list()
 
         # Download file
-        experiment.file(file_id="123").download()
-        experiment.file(file_id="123", dest_path="./model.pt").download()
+        experiment.files(file_id="123").download()
+        experiment.files(file_id="123", dest_path="./model.pt").download()
 
         # Delete file
-        experiment.file(file_id="123").delete()
+        experiment.files(file_id="123").delete()
     """
 
     def __init__(self, experiment: 'Experiment', **kwargs):
@@ -72,7 +72,7 @@ class FileBuilder:
             ValueError: If file size exceeds 5GB limit
 
         Examples:
-            result = experiment.file(file_path="./model.pt", prefix="/models").save()
+            result = experiment.files(file_path="./model.pt", prefix="/models").save()
             # Returns: {"id": "123", "path": "/models", "filename": "model.pt", ...}
         """
         if not self._experiment._is_open:
@@ -130,9 +130,9 @@ class FileBuilder:
             RuntimeError: If experiment is not open
 
         Examples:
-            files = experiment.file().list()  # All files
-            files = experiment.file(prefix="/models").list()  # Filter by prefix
-            files = experiment.file(tags=["checkpoint"]).list()  # Filter by tags
+            files = experiment.files().list()  # All files
+            files = experiment.files(prefix="/models").list()  # Filter by prefix
+            files = experiment.files(tags=["checkpoint"]).list()  # Filter by tags
         """
         if not self._experiment._is_open:
             raise RuntimeError("Experiment not open. Use experiment.open() or context manager.")
@@ -158,10 +158,10 @@ class FileBuilder:
 
         Examples:
             # Download to current directory with original filename
-            path = experiment.file(file_id="123").download()
+            path = experiment.files(file_id="123").download()
 
             # Download to custom path
-            path = experiment.file(file_id="123", dest_path="./model.pt").download()
+            path = experiment.files(file_id="123", dest_path="./model.pt").download()
         """
         if not self._experiment._is_open:
             raise RuntimeError("Experiment not open. Use experiment.open() or context manager.")
@@ -186,7 +186,7 @@ class FileBuilder:
             ValueError: If file_id not provided
 
         Examples:
-            result = experiment.file(file_id="123").delete()
+            result = experiment.files(file_id="123").delete()
         """
         if not self._experiment._is_open:
             raise RuntimeError("Experiment not open. Use experiment.open() or context manager.")
@@ -211,7 +211,7 @@ class FileBuilder:
             ValueError: If file_id not provided
 
         Examples:
-            result = experiment.file(
+            result = experiment.files(
                 file_id="123",
                 description="Updated description",
                 tags=["new", "tags"],
@@ -251,7 +251,7 @@ class FileBuilder:
 
         Examples:
             config = {"model": "resnet50", "lr": 0.001}
-            result = experiment.file(prefix="/configs").save_json(config, "config.json")
+            result = experiment.files(prefix="/configs").save_json(config, "config.json")
         """
         import json
         import tempfile
@@ -309,10 +309,10 @@ class FileBuilder:
         Examples:
             import torch
             model = torch.nn.Linear(10, 5)
-            result = experiment.file(prefix="/models").save_torch(model, "model.pt")
+            result = experiment.files(prefix="/models").save_torch(model, "model.pt")
 
             # Or save state dict
-            result = experiment.file(prefix="/models").save_torch(model.state_dict(), "model.pth")
+            result = experiment.files(prefix="/models").save_torch(model.state_dict(), "model.pth")
         """
         import tempfile
         import os
@@ -372,10 +372,10 @@ class FileBuilder:
 
         Examples:
             data = {"model": "resnet50", "weights": np.array([1, 2, 3])}
-            result = experiment.file(prefix="/data").save_pkl(data, "data.pkl")
+            result = experiment.files(prefix="/data").save_pkl(data, "data.pkl")
 
             # Or save any Python object
-            result = experiment.file(prefix="/models").save_pkl(trained_model, "model.pickle")
+            result = experiment.files(prefix="/models").save_pkl(trained_model, "model.pickle")
         """
         import pickle
         import tempfile

{ml_dash-0.5.3 → ml_dash-0.5.5}/src/ml_dash/metric.py

@@ -15,16 +15,20 @@ class MetricsManager:
     """
     Manager for metric operations that supports both named and unnamed usage.
 
-    Supports two usage patterns:
-    1. Named: experiment.metrics("loss").append(value=0.5, step=1)
-    2. Unnamed: experiment.metrics.append(name="loss", value=0.5, step=1)
+    Supports three usage patterns:
+    1. Named via call: experiment.metrics("loss").append(value=0.5, step=1)
+    2. Named via argument: experiment.metrics.append(name="loss", value=0.5, step=1)
+    3. Unnamed: experiment.metrics.append(value=0.5, step=1)  # name=None
 
     Usage:
-        # With explicit metric name
+        # With explicit metric name (via call)
         experiment.metrics("train_loss").append(value=0.5, step=100)
 
-        # Without specifying name upfront (name in append call)
+        # With explicit metric name (via argument)
         experiment.metrics.append(name="train_loss", value=0.5, step=100)
+
+        # Without name (uses None as metric name)
+        experiment.metrics.append(value=0.5, step=100)
     """
 
     def __init__(self, experiment: 'Experiment'):
@@ -55,12 +59,12 @@ class MetricsManager:
         """
         return MetricBuilder(self._experiment, name, description, tags, metadata)
 
-    def append(self, name: str, data: Optional[Dict[str, Any]] = None, **kwargs) -> Dict[str, Any]:
+    def append(self, name: Optional[str] = None, data: Optional[Dict[str, Any]] = None, **kwargs) -> Dict[str, Any]:
         """
-        Append a data point to a metric (name specified in call).
+        Append a data point to a metric (name can be optional).
 
         Args:
-            name: Metric name
+            name: Metric name (optional, can be None for unnamed metrics)
             data: Data dict (alternative to kwargs)
             **kwargs: Data as keyword arguments
 
@@ -69,13 +73,14 @@ class MetricsManager:
 
         Examples:
             experiment.metrics.append(name="loss", value=0.5, step=1)
+            experiment.metrics.append(value=0.5, step=1)  # name=None
             experiment.metrics.append(name="loss", data={"value": 0.5, "step": 1})
         """
         if data is None:
             data = kwargs
         return self._experiment._append_to_metric(name, data, None, None, None)
 
-    def append_batch(self, name: str, data_points: List[Dict[str, Any]],
+    def append_batch(self, name: Optional[str] = None, data_points: Optional[List[Dict[str, Any]]] = None,
                      description: Optional[str] = None,
                      tags: Optional[List[str]] = None,
                      metadata: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
@@ -83,7 +88,7 @@ class MetricsManager:
         Append multiple data points to a metric.
 
         Args:
-            name: Metric name
+            name: Metric name (optional, can be None for unnamed metrics)
             data_points: List of data point dicts
             description: Optional metric description
             tags: Optional tags for categorization
@@ -100,7 +105,15 @@ class MetricsManager:
                     {"value": 0.4, "step": 2}
                 ]
             )
+            experiment.metrics.append_batch(
+                data_points=[
+                    {"value": 0.5, "step": 1},
+                    {"value": 0.4, "step": 2}
+                ]
+            )  # name=None
         """
+        if data_points is None:
+            data_points = []
         return self._experiment._append_batch_to_metric(name, data_points, description, tags, metadata)
 
 

{ml_dash-0.5.3 → ml_dash-0.5.5}/src/ml_dash/storage.py

@@ -636,7 +636,7 @@ class LocalStorage:
         self,
         project: str,
         experiment: str,
-        metric_name: str,
+        metric_name: Optional[str],
         data: Dict[str, Any],
         description: Optional[str] = None,
         tags: Optional[List[str]] = None,
@@ -653,7 +653,7 @@ class LocalStorage:
         Args:
             project: Project name
             experiment: Experiment name
-            metric_name: Metric name
+            metric_name: Metric name (None for unnamed metrics)
             data: Data point (flexible schema)
             description: Optional metric description
             tags: Optional tags
@@ -666,7 +666,9 @@ class LocalStorage:
         metrics_dir = experiment_dir / "metrics"
         metrics_dir.mkdir(parents=True, exist_ok=True)
 
-        metric_dir = metrics_dir / metric_name
+        # Convert None to string for directory name
+        dir_name = str(metric_name) if metric_name is not None else "None"
+        metric_dir = metrics_dir / dir_name
         metric_dir.mkdir(exist_ok=True)
 
         data_file = metric_dir / "data.jsonl"
@@ -720,7 +722,7 @@ class LocalStorage:
         self,
         project: str,
         experiment: str,
-        metric_name: str,
+        metric_name: Optional[str],
         data_points: List[Dict[str, Any]],
         description: Optional[str] = None,
         tags: Optional[List[str]] = None,
@@ -732,7 +734,7 @@ class LocalStorage:
         Args:
             project: Project name
             experiment: Experiment name
-            metric_name: Metric name
+            metric_name: Metric name (None for unnamed metrics)
             data_points: List of data points
             description: Optional metric description
             tags: Optional tags
@@ -745,7 +747,9 @@ class LocalStorage:
         metrics_dir = experiment_dir / "metrics"
         metrics_dir.mkdir(parents=True, exist_ok=True)
 
-        metric_dir = metrics_dir / metric_name
+        # Convert None to string for directory name
+        dir_name = str(metric_name) if metric_name is not None else "None"
+        metric_dir = metrics_dir / dir_name
         metric_dir.mkdir(exist_ok=True)
 
         data_file = metric_dir / "data.jsonl"