ml-dash 0.5.9__py3-none-any.whl → 0.6.0__py3-none-any.whl

ml_dash/params.py

@@ -6,6 +6,7 @@ Nested dicts are flattened to dot-notation: {"model": {"lr": 0.001}} → {"model
 """
 
 from typing import Dict, Any, Optional, TYPE_CHECKING
+import inspect
 
 if TYPE_CHECKING:
     from .experiment import Experiment
@@ -62,13 +63,21 @@ class ParametersBuilder:
             experiment.parameters().set(**{"model.lr": 0.001, "model.batch_size": 32})
         """
         if not self._experiment._is_open:
-            raise RuntimeError("Experiment not open. Use experiment.run.start() or context manager.")
+            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)"
+            )
 
         if self._experiment._write_protected:
             raise RuntimeError("Experiment is write-protected and cannot be modified.")
 
+        # Convert class objects to dicts (for params_proto support)
+        processed_kwargs = self._process_class_objects(kwargs)
+
         # Flatten the kwargs
-        flattened = self.flatten_dict(kwargs)
+        flattened = self.flatten_dict(processed_kwargs)
 
         if not flattened:
             # No parameters to set, just return
@@ -79,6 +88,43 @@ class ParametersBuilder:
 
         return self
 
+    def log(self, **kwargs) -> 'ParametersBuilder':
+        """
+        Alias for set(). Sets/merges parameters.
+
+        This method exists for better parameter organization and semantic clarity.
+        It behaves exactly the same as set().
+
+        Nested dicts are automatically flattened:
+            log(model={"lr": 0.001, "batch_size": 32})
+            → {"model.lr": 0.001, "model.batch_size": 32}
+
+        Args:
+            **kwargs: Parameters to set (can be nested dicts)
+
+        Returns:
+            Self for potential chaining
+
+        Raises:
+            RuntimeError: If experiment is not open
+            RuntimeError: If experiment is write-protected
+
+        Examples:
+            # Set parameters using log() - same as set()
+            experiment.params.log(
+                learning_rate=0.001,
+                batch_size=32,
+                model="resnet50"
+            )
+
+            # Track parameter changes during training
+            for epoch in range(10):
+                if epoch == 5:
+                    experiment.params.log(learning_rate=0.0001)  # Log LR decay
+        """
+        # Just call set() - they behave exactly the same
+        return self.set(**kwargs)
+
     def get(self, flatten: bool = True) -> Dict[str, Any]:
         """
         Get parameters from the experiment.
@@ -103,7 +149,12 @@ class ParametersBuilder:
             # → {"model": {"lr": 0.001, "batch_size": 32}, "optimizer": "adam"}
         """
         if not self._experiment._is_open:
-            raise RuntimeError("Experiment not open. Use experiment.open() or context manager.")
+            raise RuntimeError(
+                "Experiment not started. Use 'with experiment.run:' or call experiment.run.start() first.\n"
+                "Example:\n"
+                "  with dxp.run:\n"
+                "      dxp.params.get()"
+            )
 
         # Read parameters through experiment
         params = self._experiment._read_params()
@@ -186,3 +237,41 @@ class ParametersBuilder:
             current[parts[-1]] = value
 
         return result
+
+    @staticmethod
+    def _process_class_objects(d: Dict[str, Any]) -> Dict[str, Any]:
+        """
+        Convert class objects to dicts by extracting their attributes.
+
+        This enables passing configuration classes directly:
+            dxp.params.log(Args=Args)  # Args is a class
+            → {"Args": {"batch_size": 64, "lr": 0.001, ...}}
+
+        Args:
+            d: Dictionary that may contain class objects as values
+
+        Returns:
+            Dictionary with class objects converted to attribute dicts
+
+        Examples:
+            >>> class Args:
+            ...     batch_size = 64
+            ...     lr = 0.001
+            >>> _process_class_objects({"Args": Args})
+            {"Args": {"batch_size": 64, "lr": 0.001}}
+        """
+        result = {}
+        for key, value in d.items():
+            if inspect.isclass(value):
+                # Extract class attributes (skip private/magic and callables)
+                attrs = {}
+                for attr_name, attr_value in vars(value).items():
+                    if not attr_name.startswith('_') and not callable(attr_value):
+                        # Recursively handle nested types
+                        if isinstance(attr_value, type):
+                            continue  # Skip type annotations
+                        attrs[attr_name] = attr_value
+                result[key] = attrs
+            else:
+                result[key] = value
+        return result

ml_dash/remote_auto_start.py

@@ -0,0 +1,55 @@
+"""
+Pre-configured remote experiment singleton for ML-Dash SDK.
+
+Provides a pre-configured experiment singleton named 'rdxp' that uses remote mode.
+Requires manual start using 'with' statement or explicit start() call.
+
+IMPORTANT: Before using rdxp, you must authenticate with the ML-Dash server:
+    # First time setup - authenticate with the server
+    python -m ml_dash.cli login
+
+Usage:
+    from ml_dash import rdxp
+
+    # Use with statement (recommended)
+    with rdxp.run:
+        rdxp.log().info("Hello from rdxp!")
+        rdxp.params.set(lr=0.001)
+        rdxp.metrics("loss").append(step=0, value=0.5)
+    # Automatically completes on exit from with block
+
+    # Or start/complete manually
+    rdxp.run.start()
+    rdxp.log().info("Training...")
+    rdxp.run.complete()
+
+Configuration:
+    - Default server: https://api.dash.ml
+    - To use a different server, set MLDASH_API_URL environment variable
+    - Authentication token is auto-loaded from secure storage
+"""
+
+import atexit
+from .experiment import Experiment
+
+# Create pre-configured singleton experiment for remote mode
+# Uses remote API server - token auto-loaded from storage
+rdxp = Experiment(
+    name="rdxp",
+    project="scratch",
+    remote="https://api.dash.ml"
+)
+
+# Register cleanup handler to complete experiment on Python exit (if still open)
+def _cleanup():
+    """Complete the rdxp experiment on exit if still open."""
+    if rdxp._is_open:
+        try:
+            rdxp.run.complete()
+        except Exception:
+            # Silently ignore errors during cleanup
+            pass
+
+atexit.register(_cleanup)
+
+__all__ = ["rdxp"]

ml_dash/storage.py

@@ -189,9 +189,10 @@ class LocalStorage:
         self,
         project: str,
         experiment: str,
-        message: str,
-        level: str,
-        timestamp: str,
+        folder: Optional[str] = None,
+        message: str = "",
+        level: str = "info",
+        timestamp: str = "",
         metadata: Optional[Dict[str, Any]] = None,
     ):
         """
@@ -200,12 +201,13 @@ class LocalStorage:
         Args:
             project: Project name
             experiment: Experiment name
+            folder: Optional folder path
             message: Log message
             level: Log level
             timestamp: ISO timestamp string
             metadata: Optional metadata
         """
-        experiment_dir = self._get_experiment_dir(project, experiment)
+        experiment_dir = self._get_experiment_dir(project, experiment, folder)
         logs_dir = experiment_dir / "logs"
         logs_file = logs_dir / "logs.jsonl"
         seq_file = logs_dir / ".log_sequence"
@@ -269,7 +271,8 @@ class LocalStorage:
         self,
         project: str,
         experiment: str,
-        data: Dict[str, Any],
+        folder: Optional[str] = None,
+        data: Optional[Dict[str, Any]] = None,
     ):
         """
         Write/merge parameters. Always merges with existing parameters.
@@ -284,9 +287,12 @@ class LocalStorage:
         Args:
             project: Project name
             experiment: Experiment name
+            folder: Optional folder path
             data: Flattened parameter dict with dot notation (already flattened)
         """
-        experiment_dir = self._get_experiment_dir(project, experiment)
+        if data is None:
+            data = {}
+        experiment_dir = self._get_experiment_dir(project, experiment, folder)
         params_file = experiment_dir / "parameters.json"
 
         # File-based lock for concurrent parameter writes (prevents data loss and version conflicts)
@@ -366,15 +372,16 @@ class LocalStorage:
         self,
         project: str,
         experiment: str,
-        file_path: str,
-        prefix: str,
-        filename: str,
-        description: Optional[str],
-        tags: Optional[List[str]],
-        metadata: Optional[Dict[str, Any]],
-        checksum: str,
-        content_type: str,
-        size_bytes: int
+        folder: Optional[str] = None,
+        file_path: str = "",
+        prefix: str = "",
+        filename: str = "",
+        description: Optional[str] = None,
+        tags: Optional[List[str]] = None,
+        metadata: Optional[Dict[str, Any]] = None,
+        checksum: str = "",
+        content_type: str = "",
+        size_bytes: int = 0
     ) -> Dict[str, Any]:
         """
         Write file to local storage.
@@ -385,6 +392,7 @@ class LocalStorage:
         Args:
             project: Project name
             experiment: Experiment name
+            folder: Optional folder path
             file_path: Source file path
             prefix: Logical path prefix
             filename: Original filename
@@ -401,7 +409,7 @@ class LocalStorage:
         import shutil
         from .files import generate_snowflake_id
 
-        experiment_dir = self._get_experiment_dir(project, experiment)
+        experiment_dir = self._get_experiment_dir(project, experiment, folder)
         files_dir = experiment_dir / "files"
         metadata_file = files_dir / ".files_metadata.json"
 
@@ -774,8 +782,9 @@ class LocalStorage:
         self,
         project: str,
         experiment: str,
-        metric_name: Optional[str],
-        data: Dict[str, Any],
+        folder: Optional[str] = None,
+        metric_name: Optional[str] = None,
+        data: Optional[Dict[str, Any]] = None,
         description: Optional[str] = None,
         tags: Optional[List[str]] = None,
         metadata: Optional[Dict[str, Any]] = None
@@ -791,6 +800,7 @@ class LocalStorage:
         Args:
             project: Project name
             experiment: Experiment name
+            folder: Optional folder path
             metric_name: Metric name (None for unnamed metrics)
             data: Data point (flexible schema)
             description: Optional metric description
@@ -800,7 +810,9 @@ class LocalStorage:
         Returns:
             Dict with metricId, index, bufferedDataPoints, chunkSize
         """
-        experiment_dir = self._get_experiment_dir(project, experiment)
+        if data is None:
+            data = {}
+        experiment_dir = self._get_experiment_dir(project, experiment, folder)
         metrics_dir = experiment_dir / "metrics"
         metrics_dir.mkdir(parents=True, exist_ok=True)
 

{ml_dash-0.5.9.dist-info → ml_dash-0.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ml-dash
-Version: 0.5.9
+Version: 0.6.0
 Summary: ML experiment tracking and data storage
 Keywords: machine-learning,experiment-tracking,mlops,data-storage
 Author: Ge Yang, Tom Tao
@@ -42,6 +42,9 @@ Requires-Dist: imageio>=2.31.0
 Requires-Dist: imageio-ffmpeg>=0.4.9
 Requires-Dist: scikit-image>=0.21.0
 Requires-Dist: rich>=13.0.0
+Requires-Dist: cryptography>=42.0.0
+Requires-Dist: keyring>=25.0.0 ; extra == 'auth'
+Requires-Dist: qrcode>=8.0.0 ; extra == 'auth'
 Requires-Dist: pytest>=8.0.0 ; extra == 'dev'
 Requires-Dist: pytest-asyncio>=0.23.0 ; extra == 'dev'
 Requires-Dist: sphinx>=7.2.0 ; extra == 'dev'
@@ -58,6 +61,7 @@ Requires-Dist: linkify-it-py>=2.0.0 ; extra == 'dev'
 Requires-Dist: ruff>=0.3.0 ; extra == 'dev'
 Requires-Dist: mypy>=1.9.0 ; extra == 'dev'
 Requires-Python: >=3.9
+Provides-Extra: auth
 Provides-Extra: dev
 Description-Content-Type: text/markdown
 

ml_dash-0.6.0.dist-info/RECORD

@@ -0,0 +1,29 @@
+ml_dash/__init__.py,sha256=eO526uX_T_Y5tySTVw2ZN-QCR46120gYPD6DWhenMUw,2228
+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=vuWDAhQPdjUwNTJAdoWP-EUDudIJVTNdWkWnvgS4Qgc,8217
+ml_dash/auto_start.py,sha256=u1dSzP7S_ZL2w81Yvft_fS6JysU2z6pfNyMvjtYQe-8,1820
+ml_dash/cli.py,sha256=r55bNa3T_guMnSl2dwsj0WF9Ln-vOGsBmbrooMKYhRI,2103
+ml_dash/cli_commands/__init__.py,sha256=bjAmV7MsW-bhtW_4SnLJ0Cfkt9h82vMDC8ebW1Ke8KE,38
+ml_dash/cli_commands/download.py,sha256=jOUx2aejA_Hz4ttuL8ubFY3pI4j39fYtdn-sZyrYCrE,28674
+ml_dash/cli_commands/list.py,sha256=0G0XMJ8cH8_k37IEjwq20t6obT-tKxZPTxr221UF8KA,9757
+ml_dash/cli_commands/login.py,sha256=0v8UPj_Y-uYmNDfc8Zv6xddFJPx3_VgVNeESYO700b0,7173
+ml_dash/cli_commands/logout.py,sha256=lTUUNyRXqvo61qNkCd4KBrPUujDAHnNqsHkU6bHie0U,1332
+ml_dash/cli_commands/upload.py,sha256=4O9iZOQDOiiBBsoDG1Cr8BqeBGSZZSfc3i-5FERjFtU,46439
+ml_dash/client.py,sha256=TBIPY0ti31hcyWHGW8SexBUNcSzo-aJ4hLlZtMViPD8,28902
+ml_dash/config.py,sha256=aNqX_HT2Yo-BzjFexQ97gQK9xOiBUwuJJ65dKM3oJjs,3481
+ml_dash/experiment.py,sha256=qEwPq8U6YXw-bmEBOZX0yL-4Y8TTZYuFsKtMarq8duA,33913
+ml_dash/files.py,sha256=p9s15eqgGAf-6bZntXkd_YicS6GjSGzEKAN_YoMuAXQ,26541
+ml_dash/log.py,sha256=0yXaNnFwYeBI3tRLHX3kkqWRpg0MbSGwmgjnOfsElCk,5350
+ml_dash/metric.py,sha256=vz3YwO1YBWZ797l7TzD5m9WwNBBXlrATyRRzSti8QS0,17194
+ml_dash/params.py,sha256=S4wHQfv0EQRXRrFbKLuEKTQOLp5eqnALcIk1pZNroBM,9124
+ml_dash/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ml_dash/remote_auto_start.py,sha256=BAsTu41e9SboeSCn9N2vn4ftoYeUVklcAcNM45HJVGA,1610
+ml_dash/storage.py,sha256=OTMMHSLYHk_MBfo8PyMQBHD8AZ2TFTS8KSMhVhpG-hg,39493
+ml_dash-0.6.0.dist-info/WHEEL,sha256=z-mOpxbJHqy3cq6SvUThBZdaLGFZzdZPtgWLcP2NKjQ,79
+ml_dash-0.6.0.dist-info/entry_points.txt,sha256=dYs2EHX1uRNO7AQGNnVaJJpgiy0Z9q7tiy4fHSyaf3Q,46
+ml_dash-0.6.0.dist-info/METADATA,sha256=UCpvpQfajtLaLvsRQQ84Ci0uNXgsRnNnyIE6NxAASL0,6328
+ml_dash-0.6.0.dist-info/RECORD,,

ml_dash-0.5.9.dist-info/RECORD

@@ -1,20 +0,0 @@
-ml_dash/__init__.py,sha256=o_LrWVJBY_VkUGhSBs5wdb_NqEsHD1AK9HGsjZGxHxQ,1414
-ml_dash/auto_start.py,sha256=c3XcXFpZdvjtWauEoK5043Gw9k0L_5IDq4fdiB2ha88,959
-ml_dash/cli.py,sha256=lyWVVhmsflSXQt2UCDb8IqC-mSRQwwlB2l1qEIYBUb8,1743
-ml_dash/cli_commands/__init__.py,sha256=bjAmV7MsW-bhtW_4SnLJ0Cfkt9h82vMDC8ebW1Ke8KE,38
-ml_dash/cli_commands/download.py,sha256=TomyUFwelqfQHfh60K7rCyCwEZVp1CkMToogprgC64Q,29614
-ml_dash/cli_commands/list.py,sha256=Cx9yWsTV5HPaevYpQ6BugCEr5z_4bhxQ0T51OXExuTU,10900
-ml_dash/cli_commands/upload.py,sha256=jo6FVdbuokTz64rjvOEWWhLBzlh2gM0Ru4TRNv9hX60,47943
-ml_dash/client.py,sha256=31C2Kb3KULwhrb3UlpCFY7HDA3-kvj3XVmWUvXEvQHY,27993
-ml_dash/config.py,sha256=iQbHCu4lM_Sg8YadyEXSJ6Ht9yKIJHN26L7L-rMH4gE,3112
-ml_dash/experiment.py,sha256=K36HkHJb_O2-vdaPPOCq74_2nZtfiLaS0o7qhTntD8Q,30646
-ml_dash/files.py,sha256=JptjoxGJiXJ-nkj6C7vDhw-cgJRCB0cHt_SIUJG665o,23024
-ml_dash/log.py,sha256=0yXaNnFwYeBI3tRLHX3kkqWRpg0MbSGwmgjnOfsElCk,5350
-ml_dash/metric.py,sha256=c0Zl0wEufmQuVfwIMvrORLwqe92Iaf0PfKRgmlgQWzQ,10343
-ml_dash/params.py,sha256=xaByDSVar4D1pZqxTANkMPeZTL5-V7ewJe5TXfPLhMQ,5980
-ml_dash/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ml_dash/storage.py,sha256=1NLkIOZeFv0e97zieEX0tJT3qHTuM8UN6hvsFRQ6TTo,38941
-ml_dash-0.5.9.dist-info/WHEEL,sha256=z-mOpxbJHqy3cq6SvUThBZdaLGFZzdZPtgWLcP2NKjQ,79
-ml_dash-0.5.9.dist-info/entry_points.txt,sha256=dYs2EHX1uRNO7AQGNnVaJJpgiy0Z9q7tiy4fHSyaf3Q,46
-ml_dash-0.5.9.dist-info/METADATA,sha256=Acfle-Q8_jExDsli8yuZ8EMP1knWSkPtONo1FYB1sM4,6175
-ml_dash-0.5.9.dist-info/RECORD,,