mlops-python-sdk 0.0.1__py3-none-any.whl

mlops_python_sdk-0.0.1.dist-info/METADATA

@@ -0,0 +1,416 @@
+Metadata-Version: 2.3
+Name: mlops-python-sdk
+Version: 0.0.1
+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
+
+# MLOps Python SDK
+
+[MLOps](https://mlops.cloud) Python SDK for XCloud Service API. Manage and execute tasks with confidence.
+
+## Installation
+
+Install the SDK from PyPI:
+
+```bash
+pip install mlops-python-sdk
+```
+
+## Quick Start
+
+### 1. Setup Authentication
+
+You can authenticate using either an API Key or an Access Token.
+
+#### Option 1: API Key (Recommended for programmatic access)
+
+1. Sign up at [MLOps](https://xcloud-service.com)
+2. Create an API key from [API Keys](https://xcloud-service.com/home/api-keys)
+3. Set environment variables:
+
+```bash
+export MLOPS_API_KEY=xck_******
+export MLOPS_DOMAIN=localhost:8090  # optional, default is localhost:8090
+```
+
+#### Option 2: Access Token (For user authentication)
+
+```bash
+export MLOPS_ACCESS_TOKEN=your_access_token
+export MLOPS_DOMAIN=localhost:8090  # optional
+```
+
+### 2. Basic Usage
+
+```python
+from client import Task, ConnectionConfig
+from client.api.client.models.task_status import TaskStatus
+
+# Initialize Task client (uses environment variables by default)
+task = Task()
+
+# Or initialize with explicit configuration
+config = ConnectionConfig(
+    api_key="xck_******",
+    domain="localhost:8090",
+    debug=False
+)
+task = Task(config=config)
+
+# Submit a task with script
+result = task.submit(
+    name="my-training-task",
+    cluster_id=1,
+    script="#!/bin/bash\necho 'Hello World'",
+    resources={"cpu": 4, "memory": "8GB", "gpu": 1}
+)
+
+# Or submit with command
+result = task.submit(
+    name="my-task",
+    cluster_id=1,
+    command="python train.py",
+    resources={"cpu": 4, "memory": "8GB"}
+)
+
+# Get task details
+task_info = task.get(task_id=result.job_id, cluster_id=1)
+
+# List tasks with filters
+running_tasks = task.list(
+    status=TaskStatus.RUNNING,
+    cluster_id=1,
+    page=1,
+    page_size=20
+)
+
+# Cancel a task
+task.cancel(task_id=result.job_id, cluster_id=1)
+
+# Delete a task
+task.delete(task_id=task_id, cluster_id=1)
+```
+
+## API Reference
+
+### Task Class
+
+The `Task` class provides a high-level interface for managing tasks.
+
+#### Initialization
+
+```python
+from client import Task, ConnectionConfig
+
+# Using environment variables
+task = Task()
+
+# With explicit configuration
+config = ConnectionConfig(
+    api_key="xck_******",           # API key for authentication
+    access_token="token_******",     # Access token (alternative to API key)
+    domain="localhost:8090",         # API domain
+    debug=False,                      # Enable debug mode
+    request_timeout=30.0              # Request timeout in seconds
+)
+task = Task(config=config)
+
+# Or pass parameters directly
+task = Task(
+    api_key="xck_******",
+    domain="localhost:8090"
+)
+```
+
+#### Methods
+
+##### `submit()`
+
+Submit a new task to the cluster.
+
+```python
+result = task.submit(
+    name: str,                    # Task name (required)
+    cluster_id: int,              # Cluster ID (required)
+    script: Optional[str] = None, # Script content (script or command required)
+    command: Optional[str] = None,# Command to execute (script or command required)
+    resources: Optional[dict] = None, # Resource requirements
+    team_id: Optional[int] = None # Team ID (optional)
+) -> TaskSubmitResponse
+```
+
+**Resources dictionary** can contain:
+- `cpu` or `cpus_per_task`: Number of CPUs
+- `memory`: Memory requirement (e.g., "8GB", "4096M")
+- `nodes`: Number of nodes
+- `gres`: GPU resources (e.g., "gpu:1")
+- `time`: Time limit (e.g., "1-00:00:00" for 1 day)
+- `partition`: Partition name
+- `tres`: TRES specification
+
+**Example:**
+
+```python
+result = task.submit(
+    name="ml-training",
+    cluster_id=1,
+    script="#!/bin/bash\npython train.py --epochs 100",
+    resources={
+        "cpu": 8,
+        "memory": "16GB",
+        "gpu": 1,
+        "time": "2-00:00:00",  # 2 days
+        "partition": "gpu"
+    }
+)
+print(f"Task submitted: Job ID = {result.job_id}")
+```
+
+##### `get()`
+
+Get task details by task ID.
+
+```python
+task_info = task.get(
+    task_id: int,    # Task ID (Slurm job ID)
+    cluster_id: int  # Cluster ID (required)
+) -> Task
+```
+
+**Example:**
+
+```python
+task_info = task.get(task_id=12345, cluster_id=1)
+print(f"Task status: {task_info.status}")
+print(f"Task name: {task_info.name}")
+```
+
+##### `list()`
+
+List tasks with optional filters and pagination.
+
+```python
+tasks = task.list(
+    page: int = 1,                           # Page number
+    page_size: int = 20,                     # Items per page
+    status: Optional[TaskStatus] = None,     # Filter by status
+    cluster_id: Optional[int] = None,         # Filter by cluster ID
+    team_id: Optional[int] = None,           # Filter by team ID
+    user_id: Optional[int] = None            # Filter by user ID
+) -> TaskListResponse
+```
+
+**Example:**
+
+```python
+from client.api.client.models.task_status import TaskStatus
+
+# List all running tasks
+running_tasks = task.list(status=TaskStatus.RUNNING)
+
+# List tasks in a specific cluster
+cluster_tasks = task.list(cluster_id=1, page=1, page_size=10)
+
+# List completed tasks with pagination
+completed = task.list(
+    status=TaskStatus.COMPLETED,
+    cluster_id=1,
+    page=1,
+    page_size=50
+)
+```
+
+##### `cancel()`
+
+Cancel a running task.
+
+```python
+task.cancel(
+    task_id: int,    # Task ID (Slurm job ID)
+    cluster_id: int  # Cluster ID (required)
+)
+```
+
+**Example:**
+
+```python
+task.cancel(task_id=12345, cluster_id=1)
+```
+
+### TaskStatus Enum
+
+Task status values for filtering:
+
+```python
+from client.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
+```
+
+## Configuration
+
+### Environment Variables
+
+The SDK reads configuration from environment variables:
+
+- `MLOPS_API_KEY`: API key for authentication
+- `MLOPS_ACCESS_TOKEN`: Access token for authentication (alternative to API key)
+- `MLOPS_DOMAIN`: API domain (default: `localhost:8090`)
+- `MLOPS_DEBUG`: Enable debug mode (`true`/`false`, default: `false`)
+- `MLOPS_API_PATH`: API path prefix (default: `/api/v1`)
+
+### ConnectionConfig
+
+You can also configure the connection programmatically:
+
+```python
+from client import ConnectionConfig
+
+config = ConnectionConfig(
+    domain="api.example.com",
+    api_key="xck_******",
+    debug=True,
+    request_timeout=60.0,
+    api_path="/api/v1"
+)
+```
+
+## Error Handling
+
+The SDK provides specific exception types:
+
+```python
+from client.exceptions import (
+    APIException,           # General API errors
+    AuthenticationException, # Authentication failures
+    NotFoundException,       # Resource not found
+    RateLimitException,     # Rate limit exceeded
+    TimeoutException,       # Request timeout
+    InvalidArgumentException # Invalid arguments
+)
+
+try:
+    result = task.submit(name="test", cluster_id=1, 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}")
+```
+
+## Examples
+
+### Submit a Machine Learning Training Job
+
+```python
+from client import Task
+
+task = Task()
+
+result = task.submit(
+    name="pytorch-training",
+    cluster_id=1,
+    script="""#!/bin/bash
+#SBATCH --gres=gpu:1
+#SBATCH --cpus-per-task=8
+#SBATCH --mem=32GB
+
+python train.py --config config.yaml
+""",
+    resources={
+        "cpus_per_task": 8,
+        "memory": "32GB",
+        "gres": "gpu:1",
+        "time": "4-00:00:00",  # 4 days
+        "partition": "gpu"
+    }
+)
+
+print(f"Training job submitted: {result.job_id}")
+```
+
+### Monitor Task Status
+
+```python
+from client import Task
+from client.api.client.models.task_status import TaskStatus
+import time
+
+task = Task()
+job_id = 12345
+cluster_id = 1
+
+while True:
+    task_info = task.get(task_id=job_id, cluster_id=cluster_id)
+    print(f"Status: {task_info.status}")
+    
+    if task_info.status in [TaskStatus.COMPLETED, TaskStatus.FAILED, TaskStatus.CANCELLED]:
+        break
+    
+    time.sleep(10)  # Check every 10 seconds
+```
+
+### List and Filter Tasks
+
+```python
+from client import Task
+from client.api.client.models.task_status import TaskStatus
+
+task = Task()
+
+# Get all running tasks in cluster 1
+running = task.list(
+    status=TaskStatus.RUNNING,
+    cluster_id=1
+)
+
+for t in running.tasks:
+    print(f"{t.name}: {t.status} (Job ID: {t.job_id})")
+
+# Get failed tasks
+failed = task.list(status=TaskStatus.FAILED)
+
+print(f"Total failed tasks: {failed.total}")
+```
+
+## Documentation
+
+- [MLOPS Documentation](https://xcloud-service.com/docs)
+- [API Reference](https://xcloud-service.com/docs/api)
+
+## License
+
+MIT
+
+## Support
+
+- [GitHub Issues](https://github.com/xcloud-service/xservice/issues)
+- [Documentation](https://xcloud-service.com/docs)
+

mlops_python_sdk-0.0.1.dist-info/RECORD

@@ -0,0 +1,36 @@
+mlops/__init__.py,sha256=Hxp-gCQFecNrFAKYcYX3r5-TdxkX4poDDWE8BQKP_qA,963
+mlops/api/client/__init__.py,sha256=ebLsr_eRzRT06jQ2k4bxbX3NwD4A3gcxdVdcUBUMmIM,161
+mlops/api/client/api/__init__.py,sha256=zTSiG_ujSjAqWPyc435YXaX9XTlpMjiJWBbV-f-YtdA,45
+mlops/api/client/api/tasks/__init__.py,sha256=5vd9uJWAjRqa9xzxzYkLD1yoZ12Ld_bAaNB5WX4fbE8,56
+mlops/api/client/api/tasks/cancel_task.py,sha256=abfzw5RTB7WJvpRvBgdcOp5yaS4xkJ0M0Ltmn-hNKSY,4893
+mlops/api/client/api/tasks/delete_task.py,sha256=XZ3wl5Q78FIQ_BN92QbWbJfDC1m-e4IljQYTd5stYOA,5629
+mlops/api/client/api/tasks/get_task.py,sha256=Hibf-yyvAQxYjry1hphmxC7HWgJWuT7CP94eSt_GbwQ,5119
+mlops/api/client/api/tasks/list_tasks.py,sha256=FczH2eLwPiOWLy7RqKDsOyWNkPZlEVtmojPQwJGVmZc,7534
+mlops/api/client/api/tasks/submit_task.py,sha256=fXV8QSM3J_vT4aCdYFBnqCjrNFj-pz-wBmOZWSEhttI,5015
+mlops/api/client/client.py,sha256=o_mdLqyBCQstu5tS1WZFwqIEbGwkvWQ7eQjuCJw_5VY,12419
+mlops/api/client/errors.py,sha256=gO8GBmKqmSNgAg-E5oT-oOyxztvp7V_6XG7OUTT15q0,546
+mlops/api/client/models/__init__.py,sha256=fgiC4ut7ZWxR3Hg8zgDgEUQKlOJ7UlH9NMESiDw0pc8,1141
+mlops/api/client/models/error_response.py,sha256=gmFOtAcZZTBPGrR3MXJe-_viEpfJOR9r_ffXNotaPlQ,1809
+mlops/api/client/models/message_response.py,sha256=rV3BMdP_fnmyxJW3mYLGECuUQ7VNVUKdzJwnY8Jdvu4,1609
+mlops/api/client/models/task.py,sha256=XAioNH5gHvP5mDlDJ5cJlq10jHSKJuk82YNxuAV9rZo,61827
+mlops/api/client/models/task_alloc_tres_type_0.py,sha256=U3lUyNmFDVyEZABMXJ997zn6vnPOJ_gjBJsczoPd41A,1330
+mlops/api/client/models/task_gres_detail_type_0_item.py,sha256=_DVf3bNzqfYxZvcYnhOEbXW-CuN2BhPwWQZQT9MZt-A,1272
+mlops/api/client/models/task_job_resources_type_0.py,sha256=A63CcQn2at3q9Vq137BBBi3LVbp5xVPUzFtGaE92Czw,1373
+mlops/api/client/models/task_list_response.py,sha256=nVhi5LFiTUlyvmHz9Sc9-2A-awJ7s6lNKQQfwG2OfL4,2909
+mlops/api/client/models/task_resources_type_0.py,sha256=36nxeOqAJS4ksfQtzoXigWVMhEV1Tnq5Z_64sHa3gGQ,1341
+mlops/api/client/models/task_status.py,sha256=Tht4F2UeBp-QBLhh-z0fEw45r5cBCfkFUro-la42BPY,315
+mlops/api/client/models/task_submit_request.py,sha256=TsNXB-u6noDwhcXlVa6S4SIbimD3MHVRhxbYn0239bQ,22186
+mlops/api/client/models/task_submit_request_environment_type_0.py,sha256=Wx6ye6vVHytSex186AeUm27-XMWMmZe6lbL2Ons2mkw,1454
+mlops/api/client/models/task_submit_response.py,sha256=EK3ZXxo_XO5Yn2zdOrR-VMPKg9om49qQ1ywS2Smgink,2200
+mlops/api/client/models/task_tres_type_0.py,sha256=rEaiQG7A19mlTIHDppzxuWa4oPfh9qsKjPhhVOlBf4g,1292
+mlops/api/client/models/task_tres_used_type_0.py,sha256=4w6An7-ZCqa8cc3SPi7mcwGK-ekT6AYq_dEdf8KzoYA,1320
+mlops/api/client/py.typed,sha256=8ZJUsxZiuOy1oJeVhsTWQhTG_6pTVHVXk5hJL79ebTk,25
+mlops/api/client/types.py,sha256=AX4orxQZQJat3vZrgjJ-TYb2sNBL8kNo9yqYDT-n8y8,1391
+mlops/connection_config.py,sha256=2C275BCnkQrBeCihPmU4PExbK16yjuw_ePVJMw34SVU,3176
+mlops/exceptions.py,sha256=NmWmo5Vx0ATfDq9eNT8arKUxmhniWGlcI9vViDvaf_Y,1700
+mlops/task/__init__.py,sha256=wJYM-85Xqomn5E44VmOPBXLwm3ZRgDgKgsYeDuH0kAs,135
+mlops/task/client.py,sha256=LvZqJ1n9O7ae1NZ61xwGw1_-AnlIhMxFD6cnpgwZtDk,4555
+mlops/task/task.py,sha256=shp5gqvxPEnG-ezly7CEJqERVwbtKkiJKzknQRUbMxI,17241
+mlops_python_sdk-0.0.1.dist-info/METADATA,sha256=hOsD_hL1uxMYmBt-hCKEH_DswohEvs3XzBeALxHZuAc,9878
+mlops_python_sdk-0.0.1.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+mlops_python_sdk-0.0.1.dist-info/RECORD,,

mlops_python_sdk-0.0.1.dist-info/WHEEL

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