ml-dash 0.6.1__py3-none-any.whl

ml_dash-0.6.1.dist-info/METADATA

@@ -0,0 +1,248 @@
+Metadata-Version: 2.3
+Name: ml-dash
+Version: 0.6.1
+Summary: ML experiment tracking and data storage
+Keywords: machine-learning,experiment-tracking,mlops,data-storage
+Author: Ge Yang, Tom Tao
+License: MIT License
+         
+         Copyright (c) 2025 Ge Yang, Tom Tao
+         
+         Permission is hereby granted, free of charge, to any person obtaining a copy
+         of this software and associated documentation files (the "Software"), to deal
+         in the Software without restriction, including without limitation the rights
+         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+         copies of the Software, and to permit persons to whom the Software is
+         furnished to do so, subject to the following conditions:
+         
+         The above copyright notice and this permission notice shall be included in all
+         copies or substantial portions of the Software.
+         
+         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+         SOFTWARE.
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: pyjwt>=2.8.0
+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'
+Requires-Dist: furo>=2024.0.0 ; extra == 'dev'
+Requires-Dist: sphinx-autodoc-typehints>=2.0.0 ; extra == 'dev'
+Requires-Dist: sphinx-autobuild>=2024.0.0 ; extra == 'dev'
+Requires-Dist: sphinx-copybutton>=0.5.0 ; extra == 'dev'
+Requires-Dist: sphinx-design>=0.5.0 ; extra == 'dev'
+Requires-Dist: sphinx-tabs>=3.4.0 ; extra == 'dev'
+Requires-Dist: sphinxcontrib-mermaid>=0.9.0 ; extra == 'dev'
+Requires-Dist: sphinxext-opengraph>=0.9.0 ; extra == 'dev'
+Requires-Dist: myst-parser>=2.0.0 ; extra == 'dev'
+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
+
+A simple and flexible SDK for ML experiment metricing and data storage.
+
+## Features
+
+- **Three Usage Styles**: Decorator, context manager, or direct instantiation
+- **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
+
+<table>
+<tr>
+<td>Using uv (recommended)</td>
+<td>Using pip</td>
+</tr>
+<tr>
+<td>
+
+```bash
+uv add ml-dash
+```
+
+</td>
+<td>
+
+```bash
+pip install ml-dash
+```
+
+</td>
+</tr>
+</table>
+
+## Getting Started
+
+### Remote Mode (with API Server)
+
+```python
+from ml_dash import Experiment
+
+with Experiment(
+    name="my-experiment",
+    project="my-project",
+    remote="https://api.dash.ml",
+    api_key="your-jwt-token"
+) as experiment:
+    print(f"Experiment ID: {experiment.id}")
+```
+
+### Local Mode (Filesystem)
+
+```python
+from ml_dash import Experiment
+
+with Experiment(
+    name="my-experiment",
+    project="my-project",
+    local_path=".ml-dash"
+) as experiment:
+    pass  # Your code here
+```
+
+See [examples/](examples/) for more complete examples.
+
+## Development Setup
+
+### Installing Dev Dependencies
+
+To contribute to ML-Dash or run tests, install the development dependencies:
+
+<table>
+<tr>
+<td>Using uv (recommended)</td>
+<td>Using pip</td>
+</tr>
+<tr>
+<td>
+
+```bash
+uv sync --extra dev
+```
+
+</td>
+<td>
+
+```bash
+pip install -e ".[dev]"
+```
+
+</td>
+</tr>
+</table>
+
+This installs:
+- `pytest>=8.0.0` - Testing framework
+- `pytest-asyncio>=0.23.0` - Async test support
+- `sphinx>=7.2.0` - Documentation builder
+- `sphinx-rtd-theme>=2.0.0` - Read the Docs theme
+- `sphinx-autobuild>=2024.0.0` - Live preview for documentation
+- `myst-parser>=2.0.0` - Markdown support for Sphinx
+- `ruff>=0.3.0` - Linter and formatter
+- `mypy>=1.9.0` - Type checker
+
+### Running Tests
+
+<table>
+<tr>
+<td>Using uv</td>
+<td>Using pytest directly</td>
+</tr>
+<tr>
+<td>
+
+```bash
+uv run pytest
+```
+
+</td>
+<td>
+
+```bash
+pytest
+```
+
+</td>
+</tr>
+</table>
+
+### Building Documentation
+
+Documentation is built using Sphinx with Read the Docs theme.
+
+<table>
+<tr>
+<td>Build docs</td>
+<td>Live preview</td>
+<td>Clean build</td>
+</tr>
+<tr>
+<td>
+
+```bash
+uv run python -m sphinx -b html docs docs/_build/html
+```
+
+</td>
+<td>
+
+```bash
+uv run sphinx-autobuild docs docs/_build/html
+```
+
+</td>
+<td>
+
+```bash
+rm -rf docs/_build
+```
+
+</td>
+</tr>
+</table>
+
+The live preview command starts a local server and automatically rebuilds when files change.
+
+Alternatively, you can use the Makefile from within the docs directory:
+
+```bash
+cd docs
+make html          # Build HTML documentation
+make clean         # Clean build files
+```
+
+For maintainers, to build and publish a new release: `uv build && uv publish`

ml_dash-0.6.1.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=5_SIc0jyZEptGKuF5Lu910RnKcmVh03HM6QrrFST8WA,1440
+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=0jM3HzNyFy-QBN7ZLXQTuiIuiTuh4K1Zdldb4Eny0NY,29531
+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.1.dist-info/WHEEL,sha256=z-mOpxbJHqy3cq6SvUThBZdaLGFZzdZPtgWLcP2NKjQ,79
+ml_dash-0.6.1.dist-info/entry_points.txt,sha256=dYs2EHX1uRNO7AQGNnVaJJpgiy0Z9q7tiy4fHSyaf3Q,46
+ml_dash-0.6.1.dist-info/METADATA,sha256=0hRUQtm5iwiniAfYZJu9mnkJVUFnPQUPow7Va8VFqLI,6328
+ml_dash-0.6.1.dist-info/RECORD,,

ml_dash-0.6.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.9.15
+Root-Is-Purelib: true
+Tag: py3-none-any

ml_dash-0.6.1.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+ml-dash = ml_dash.cli:main
+