mlops-python-sdk 1.0.2__py3-none-any.whl → 1.0.3__py3-none-any.whl

mlops/task/task.py

@@ -6,6 +6,9 @@ This module provides a convenient interface for managing tasks through the MLOps
 
 import json
 import os
+import sys
+import threading
+import time
 from http import HTTPStatus
 from pathlib import Path
 from typing import Optional
@@ -55,13 +58,109 @@ def _validate_archive_file_path(file_path: str) -> Path:
 
 
 def _upload_file_to_presigned_url(url: str, file_path: Path, timeout: Optional[float]) -> None:
+    def _format_bytes_iec(n: int) -> str:
+        if n < 1024:
+            return f"{n}B"
+        unit = 1024.0
+        suffixes = ["KiB", "MiB", "GiB", "TiB", "PiB"]
+        v = float(n)
+        i = -1
+        while v >= unit and i < len(suffixes) - 1:
+            v /= unit
+            i += 1
+        return f"{v:.1f}{suffixes[i]}"
+
+    def _render_bar(done: int, total: int, width: int = 28) -> str:
+        if total <= 0 or width <= 1:
+            return ">"
+        done = max(0, min(done, total))
+        filled = int(width * (done / total))
+        if filled >= width:
+            return "=" * width
+        if filled <= 0:
+            return ">" + (" " * (width - 1))
+        return ("=" * filled) + ">" + (" " * (width - filled - 1))
+
+    def _format_elapsed_seconds(start: float) -> str:
+        sec = int(max(0.0, time.monotonic() - start))
+        return f"{sec}s"
+
+    class _ProgressIterable:
+        def __init__(self, f, total: int, name: str, chunk_size: int = 64 * 1024):
+            self._f = f  # file-like object
+            self._total = max(0, int(total))
+            self._name = name
+            self._chunk_size = max(1, int(chunk_size))
+            self._read = 0
+            self._start = time.monotonic()
+            self._completed = False
+            self._out = sys.stdout
+            try:
+                self._is_tty = bool(self._out.isatty())
+            except Exception:
+                self._is_tty = False
+
+        def _render_line(self, display_read: int) -> str:
+            display_read = max(0, min(int(display_read), self._total))
+            pct = (display_read / self._total) * 100.0 if self._total > 0 else 0.0
+            bar = _render_bar(display_read, self._total, width=28)
+            elapsed = _format_elapsed_seconds(self._start)
+            return (
+                f"uploading {self._name} [{bar}] {pct:6.2f}% "
+                f"({_format_bytes_iec(display_read)}/{_format_bytes_iec(self._total)}) "
+                f"elapsed {elapsed}"
+            )
+
+        def _print_line(self, line: str, final: bool = False) -> None:
+            if self._is_tty:
+                # Refresh same line in terminal.
+                print("\r" + line, end="" if not final else "\n", file=self._out, flush=True)
+            else:
+                # Always visible in non-TTY environments.
+                print(line, file=self._out, flush=True)
+
+        def __iter__(self):
+            stop_event = threading.Event()
+
+            def ticker() -> None:
+                last_sec = -1
+                # Print immediately so users see something right away.
+                self._print_line(self._render_line(self._read))
+                while not stop_event.is_set():
+                    sec = int(max(0.0, time.monotonic() - self._start))
+                    if sec != last_sec:
+                        last_sec = sec
+                        self._print_line(self._render_line(self._read))
+                    # check frequently to avoid skipping seconds
+                    stop_event.wait(0.05)
+
+            t = threading.Thread(target=ticker, name="mlops-upload-progress", daemon=True)
+            t.start()
+            try:
+                while True:
+                    chunk = self._f.read(self._chunk_size)
+                    if not chunk:
+                        break
+                    self._read += len(chunk)
+                    yield chunk
+            finally:
+                # Ensure a final 100% line and stop ticker.
+                self._read = self._total
+                self._completed = True
+                stop_event.set()
+                t.join(timeout=0.2)
+                self._print_line(self._render_line(self._read), final=True)
+
     size = file_path.stat().st_size
     # Use a dedicated client for S3 presigned upload (avoid leaking API auth headers).
     with httpx.Client(timeout=timeout) as client:
         with file_path.open("rb") as f:
+            content = f
+            if size > 0:
+                content = _ProgressIterable(f, total=size, name=file_path.name)
             resp = client.put(
                 url,
-                content=f,
+                content=content,
                 headers={
                     "Content-Length": str(size),
                     "Content-Type": "application/octet-stream",

mlops_python_sdk-1.0.3.dist-info/METADATA

@@ -0,0 +1,235 @@
+Metadata-Version: 2.3
+Name: mlops-python-sdk
+Version: 1.0.3
+Summary: MLOps Python SDK for XCloud Service API
+License: MIT
+Author: mlops
+Author-email: mlops@example.com
+Requires-Python: >=3.9,<4.0
+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
+Requires-Dist: attrs (>=23.2.0)
+Requires-Dist: httpx (>=0.27.0,<1.0.0)
+Requires-Dist: packaging (>=24.1)
+Requires-Dist: python-dateutil (>=2.8.2)
+Requires-Dist: typing-extensions (>=4.1.0)
+Project-URL: Bug Tracker, https://github.com/xcloud-service/xservice/issues
+Project-URL: Homepage, https://mlops.cloud/
+Project-URL: Repository, https://github.com/xcloud-service/xservice
+Description-Content-Type: text/markdown
+
+# SDK
+
+Software Development Kits for integrating with the XCloud Service API.
+
+> [!NOTE] SDK Support
+> SDKs provide type-safe, high-level interfaces for interacting with the platform API. They handle authentication, error handling, and request retries automatically.
+
+
+## Installation
+
+The Python SDK installation.
+
+```bash
+pip install mlops-python-sdk
+```
+
+### Configuration
+
+The SDK reads configuration from environment variables by default:
+
+- `MLOPS_API_KEY`: API key (required)
+- `MLOPS_DOMAIN`: API domain, e.g. `localhost:8090` or `https://example.com`
+- `MLOPS_API_PATH`: API path prefix (default: `/api/v1`)
+- `MLOPS_DEBUG`: `true|false` (default: `false`)
+
+Or configure in code:
+
+```python
+from mlops import ConnectionConfig, Task
+
+config = ConnectionConfig(
+    api_key="xck_...",
+    domain="https://example.com",
+    api_path="/api/v1",
+    debug=False,
+)
+task = Task(config=config)
+```
+
+## SDK Usage
+
+### Initialize client
+
+```python
+from mlops import Task
+
+task = Task()  # uses environment variables by default
+```
+
+### Submit a GPU task
+
+```python
+from mlops import Task
+
+task = Task()
+resp = task.submit(
+    name="gpu-task-from-sdk",
+    cluster_name="slurm-cn",
+    team_id=1,
+    image="/mnt/minio/images/01ai-registry.cn-shanghai.cr.aliyuncs.com+public+llamafactory+0.9.3.sqsh",
+    entry_command="llamafactory-cli train /workspace/config/test_lora.yaml",
+    resources={
+        "partition": "gpu",
+        "nodes": 2,
+        "ntasks": 2,
+        "cpus_per_task": 2,
+        "memory": "4G",
+        "time": "01:00:00",
+        "gres": "gpu:nvidia_a10:1",
+        "qos": "qos_xcloud",
+    },
+    file_path="/path/to/xservice.zip",  # optional: .zip/.tar.gz/.tgz
+)
+print(resp.job_id)
+```
+
+### Submit a CPU task
+
+```python
+from mlops import Task
+
+task = Task()
+resp = task.submit(
+    name="cpu-task-from-sdk",
+    cluster_name="slurm-cn",
+    team_id=1,
+    image="docker://01ai-registry.cn-shanghai.cr.aliyuncs.com/01-ai/xcs/v2/alpine:3.23.0",
+    entry_command="echo hello",
+    resources={
+        "partition": "cpu",
+        "nodes": 1,
+        "ntasks": 1,
+        "cpus_per_task": 1,
+        "memory": "1G",
+        "time": "01:00:00",
+        "qos": "qos_xcloud",
+    },
+)
+print(resp.job_id)
+```
+
+### List tasks
+
+```python
+from mlops import Task
+from mlops.api.client.models.task_status import TaskStatus
+
+task = Task()
+resp = task.list(status=TaskStatus.COMPLETED, cluster_name="slurm-cn", page=1, page_size=20)
+print(len(resp.tasks or []))
+```
+
+### Get task details
+
+```python
+from mlops import Task
+
+task = Task()
+task_info = task.get(task_id=12345, cluster_name="slurm-cn")
+print(task_info)
+```
+
+### Cancel a task
+
+```python
+from mlops import Task
+
+task = Task()
+task.cancel(task_id=12345, cluster_name="slurm-cn")
+```
+
+### Delete a task
+
+```python
+from mlops import Task
+
+task = Task()
+task.delete(task_id=12345, cluster_name="slurm-cn")
+```
+
+**Task Management Methods:**
+
+- `submit()` - Submit a new task with container image and entry command
+- `get()` - Get task details by task ID
+- `list()` - List tasks with optional filters (status, cluster_name, team_id, user_id)
+- `cancel()` - Cancel a running task
+- `delete()` - Delete a task record
+
+**Task Status Values:**
+
+```python
+from mlops.api.client.models.task_status import TaskStatus
+
+TaskStatus.PENDING      # Task is pending
+TaskStatus.QUEUED       # Task is queued
+TaskStatus.RUNNING      # Task is running
+TaskStatus.COMPLETED    # Task completed successfully
+TaskStatus.SUCCEEDED    # Task succeeded
+TaskStatus.FAILED       # Task failed
+TaskStatus.CANCELLED    # Task was cancelled
+TaskStatus.CREATED      # Task was created
+```
+
+**Error Handling:**
+
+```python
+from mlops.exceptions import (
+    APIException,
+    AuthenticationException,
+    NotFoundException,
+    RateLimitException,
+    TimeoutException,
+    InvalidArgumentException,
+    NotEnoughSpaceException
+)
+from mlops import Task
+
+task = Task()
+
+try:
+    result = task.submit(
+        name="test",
+        cluster_name="slurm-cn",
+        image="docker://alpine:3.23.0",
+        entry_command="echo hello",
+    )
+except AuthenticationException as e:
+    print(f"Authentication failed: {e}")
+except NotFoundException as e:
+    print(f"Resource not found: {e}")
+except APIException as e:
+    print(f"API error: {e}")
+```
+
+> [!TIP] Error Handling
+> SDKs automatically parse typed responses and raise structured exceptions.
+
+## Features
+
+- Type-safe API clients
+- Automatic authentication
+- Error handling
+- Typed response parsing (generated models)
+- Unexpected-status guard (optional)
+
+## Resources
+
+- [Python SDK Documentation](https://github.com/xcloud-service/xservice/tree/main/client/python-sdk)
+- [API Reference](https://xcloud-service.com/docs/api)
+

{mlops_python_sdk-1.0.2.dist-info → mlops_python_sdk-1.0.3.dist-info}/RECORD

@@ -46,7 +46,7 @@ mlops/connection_config.py,sha256=_b9sVFGJtf1GynmIB4NtKCzg7kkgE-wSrsG3LwzlOqk,29
 mlops/exceptions.py,sha256=3kfda-Rz0km9kV-gvnPCw7ueemWkXIGGdT0NXx6z9Xk,1680
 mlops/task/__init__.py,sha256=M983vMPLj3tZQNFXQyTP5I2RsRorFElezLeppr3WLsw,133
 mlops/task/client.py,sha256=V131WLVJl1raGAVixUhJCX8s1neN15mxAjQwO01qlIg,3552
-mlops/task/task.py,sha256=Y_lWpIVY9Wq-2iuaoZYuskcWHasUzLSpXi9fkwn7S3s,23882
-mlops_python_sdk-1.0.2.dist-info/METADATA,sha256=lBkRytOiRISGMHHzk93fijbmF9EC9iKSpHm-6I9QNsM,7637
-mlops_python_sdk-1.0.2.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-mlops_python_sdk-1.0.2.dist-info/RECORD,,
+mlops/task/task.py,sha256=Eqb4XGMlFLjelg3js9Twoulf0Nlyn0pz5isuGl916vs,27756
+mlops_python_sdk-1.0.3.dist-info/METADATA,sha256=KwMwLVAYfXBjKXXiU_p5TibVXGbli5gaxCCa0Wap9h4,5679
+mlops_python_sdk-1.0.3.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+mlops_python_sdk-1.0.3.dist-info/RECORD,,

mlops_python_sdk-1.0.2.dist-info/METADATA

@@ -1,254 +0,0 @@
-Metadata-Version: 2.3
-Name: mlops-python-sdk
-Version: 1.0.2
-Summary: MLOps Python SDK for XCloud Service API
-License: MIT
-Author: mlops
-Author-email: mlops@example.com
-Requires-Python: >=3.9,<4.0
-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
-Requires-Dist: attrs (>=23.2.0)
-Requires-Dist: httpx (>=0.27.0,<1.0.0)
-Requires-Dist: packaging (>=24.1)
-Requires-Dist: python-dateutil (>=2.8.2)
-Requires-Dist: typing-extensions (>=4.1.0)
-Project-URL: Bug Tracker, https://github.com/xcloud-service/xservice/issues
-Project-URL: Homepage, https://mlops.cloud/
-Project-URL: Repository, https://github.com/xcloud-service/xservice
-Description-Content-Type: text/markdown
-
-# SDK
-
-Software Development Kits for integrating with the XCloud Service API.
-
-> [!NOTE] SDK Support
-> SDKs provide type-safe, high-level interfaces for interacting with the platform API. They handle authentication, error handling, and request retries automatically.
-
-## Available SDKs
-
-### Python SDK
-
-### Installation
-
-The Python SDK installation.
-
-```bash
-pip install mlops-python-sdk
-```
-
-### Configuration
-
-The SDK reads configuration from environment variables by default:
-
-- `MLOPS_API_KEY`: API key (required)
-- `MLOPS_DOMAIN`: API domain, e.g. `localhost:8090` or `https://example.com`
-- `MLOPS_API_PATH`: API path prefix (default: `/api/v1`)
-- `MLOPS_DEBUG`: `true|false` (default: `false`)
-
-Or configure in code:
-
-```python
-from mlops import ConnectionConfig, Task
-
-config = ConnectionConfig(
-    api_key="xck_...",
-    domain="https://example.com",
-    api_path="/api/v1",
-    debug=False,
-)
-task = Task(config=config)
-```
-
-### Usage
-
-```python
-from mlops import Task
-from mlops.api.client.models.task_status import TaskStatus
-from pathlib import Path
-
-# Initialize Task client (uses environment variables by default)
-task = Task()
-
-# Submit a task with gpu type
-try:
-    result = task.submit(
-        name="gpu-task-from-sdk",
-        image="/mnt/minio/images/01ai-registry.cn-shanghai.cr.aliyuncs.com+public+llamafactory+0.9.3.sqsh",
-        entry_command="llamafactory-cli train /workspace/config/test_lora.yaml",
-        resources={
-            "partition": "gpu",
-            "nodes": 2,
-            "ntasks": 2,
-            "cpus_per_task": 2,
-            "memory": "4G",
-            "time": "01:00:00",
-            "gres": "gpu:nvidia_a10:1",
-            "qos": "qos_xcloud",
-            },
-        cluster_name="slurm-cn",
-        team_id=1,
-        file_path="your file path", # optional, support for .zip, .tar.gz, .tgz
-    )
-
-    if result is not None:
-        print("==== gpu task submitted successfully ====")
-        job_id = result.job_id
-    else:
-        print("==== gpu task submitted failed ====")
-except Exception as e:
-    print("==== gpu task submitted failed error ====", e)
-
-# Submit a task with cpu type
-try:
-    entry_content = Path("entry.sh").read_text(encoding="utf-8")
-    result = task.submit(
-        name="cpu-task-from-sdk",
-        image="docker://01ai-registry.cn-shanghai.cr.aliyuncs.com/01-ai/xcs/v2/alpine:3.23.0",
-        entry_command=entry_content,
-        resources={
-            "partition": "cpu",
-            "nodes": 1,
-            "ntasks": 1,
-            "cpus_per_task": 1,
-            "memory": "1G",
-            "time": "01:00:00",
-            "qos": "qos_xcloud",
-        },
-        cluster_name="slurm-cn",
-        team_id=1,
-    )
-
-    if result is not None:
-        print("==== cpu task submitted successfully ====")
-        job_id = result.job_id
-    else:
-        print("==== cpu task submitted failed ====")
-except Exception as e:
-    print("==== cpu task submitted failed error ====", e)
-
-# List tasks with filters
-try:
-    completed_tasks = task.list(
-        status=TaskStatus.COMPLETED,
-        cluster_name="slurm-cn",
-        page=1,
-        page_size=20
-    )
-
-    # Get task details
-    if completed_tasks is not None and len(completed_tasks.tasks) > 0:
-        print("==== completed_tasks number ====", len(completed_tasks.tasks))
-        task_info = task.get(task_id=completed_tasks.tasks[0].job_id, cluster_name="slurm-cn")
-        print("==== task_info ====", task_info)
-    else:
-        print("==== no completed tasks to get details ====")
-except Exception as e:
-    print("==== get task details failed error ====", e)
-
-
-# Cancel a running task
-try:
-    running_tasks = task.list(
-        status=TaskStatus.RUNNING,
-        cluster_name="slurm-cn",
-        page=1,
-        page_size=20
-    )
-    if running_tasks is not None and len(running_tasks.tasks) > 0:
-        print("==== running_tasks number ====", len(running_tasks.tasks))
-        # Cancel a task
-        result = task.cancel(task_id=running_tasks.tasks[0].job_id, cluster_name="slurm-cn")
-        print("==== task cancelled ====", running_tasks.tasks[0].job_id, result)
-    else:
-        print("==== no running tasks to cancel ====")
-except Exception as e:
-    print("==== cancel running task failed error ====", e)
-
-
-# Delete a task
-try:
-    completed_tasks = task.list(
-        status=TaskStatus.COMPLETED,
-        cluster_name="slurm-cn",
-        page=1,
-        page_size=20
-    )
-    if completed_tasks is not None and len(completed_tasks.tasks) > 0:
-        print("==== completed_tasks number ====", len(completed_tasks.tasks))
-        # Delete a task
-        result = task.delete(task_id=completed_tasks.tasks[0].job_id, cluster_name="slurm-cn")
-        print("==== task deleted ====", completed_tasks.tasks[0].job_id, result)
-    else:
-        print("==== no completed tasks to delete ====")
-except Exception as e:
-    print("==== delete completed task failed error ====", e)
-```
-
-**Task Management Methods:**
-
-- `submit()` - Submit a new task with container image and entry command
-- `get()` - Get task details by task ID
-- `list()` - List tasks with optional filters (status, cluster_name, team_id, user_id)
-- `cancel()` - Cancel a running task
-- `delete()` - Delete a task record
-
-**Task Status Values:**
-
-```python
-from mlops.api.client.models.task_status import TaskStatus
-
-TaskStatus.PENDING      # Task is pending
-TaskStatus.QUEUED       # Task is queued
-TaskStatus.RUNNING      # Task is running
-TaskStatus.COMPLETED    # Task completed successfully
-TaskStatus.SUCCEEDED    # Task succeeded
-TaskStatus.FAILED       # Task failed
-TaskStatus.CANCELLED    # Task was cancelled
-TaskStatus.CREATED      # Task was created
-```
-
-**Error Handling:**
-
-```python
-from mlops.exceptions import (
-    APIException,
-    AuthenticationException,
-    NotFoundException,
-    RateLimitException,
-    TimeoutException,
-    InvalidArgumentException,
-    NotEnoughSpaceException
-)
-
-try:
-    result = task.submit(name="test", cluster_name="slurm-cn", command="echo hello")
-except AuthenticationException as e:
-    print(f"Authentication failed: {e}")
-except NotFoundException as e:
-    print(f"Resource not found: {e}")
-except APIException as e:
-    print(f"API error: {e}")
-```
-
-> [!TIP] Error Handling
-> SDKs automatically handle common errors and retry failed requests. Check SDK documentation for error handling best practices.
-
-## Features
-
-- Type-safe API clients
-- Automatic authentication
-- Error handling
-- Request retry logic
-- Response validation
-
-## Resources
-
-- [Python SDK Documentation](https://github.com/xcloud-service/xservice/tree/main/client/python-sdk)
-- [API Reference](https://xcloud-service.com/docs/api)
-