mlops-python-sdk 0.0.1__tar.gz → 1.0.1__tar.gz

{mlops_python_sdk-0.0.1 → mlops_python_sdk-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mlops-python-sdk
-Version: 0.0.1
+Version: 1.0.1
 Summary: MLOps Python SDK for XCloud Service API
 License: MIT
 Author: mlops
@@ -25,7 +25,7 @@ Description-Content-Type: text/markdown
 
 # MLOps Python SDK
 
-[MLOps](https://mlops.cloud) Python SDK for XCloud Service API. Manage and execute tasks with confidence.
+[MLOps](https://xcloud-service.com) Python SDK for XCloud Service API. Manage and execute tasks with confidence.
 
 ## Installation
 
@@ -39,9 +39,9 @@ pip install mlops-python-sdk
 
 ### 1. Setup Authentication
 
-You can authenticate using either an API Key or an Access Token.
+You can authenticate using either an API Key.
 
-#### Option 1: API Key (Recommended for programmatic access)
+#### 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)
@@ -52,18 +52,11 @@ 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
+from mlops import Task, ConnectionConfig
+from mlops.api.client.models.task_status import TaskStatus
 
 # Initialize Task client (uses environment variables by default)
 task = Task()
@@ -119,7 +112,7 @@ The `Task` class provides a high-level interface for managing tasks.
 #### Initialization
 
 ```python
-from client import Task, ConnectionConfig
+from mlops import Task, ConnectionConfig
 
 # Using environment variables
 task = Task()
@@ -127,7 +120,6 @@ 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
@@ -222,7 +214,7 @@ tasks = task.list(
 **Example:**
 
 ```python
-from client.api.client.models.task_status import TaskStatus
+from mlops.api.client.models.task_status import TaskStatus
 
 # List all running tasks
 running_tasks = task.list(status=TaskStatus.RUNNING)
@@ -261,7 +253,7 @@ task.cancel(task_id=12345, cluster_id=1)
 Task status values for filtering:
 
 ```python
-from client.api.client.models.task_status import TaskStatus
+from mlops.api.client.models.task_status import TaskStatus
 
 TaskStatus.PENDING      # Task is pending
 TaskStatus.QUEUED       # Task is queued
@@ -280,7 +272,6 @@ TaskStatus.CREATED      # Task was created
 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`)
@@ -290,7 +281,7 @@ The SDK reads configuration from environment variables:
 You can also configure the connection programmatically:
 
 ```python
-from client import ConnectionConfig
+from mlops import ConnectionConfig
 
 config = ConnectionConfig(
     domain="api.example.com",
@@ -306,7 +297,7 @@ config = ConnectionConfig(
 The SDK provides specific exception types:
 
 ```python
-from client.exceptions import (
+from mlops.exceptions import (
     APIException,           # General API errors
     AuthenticationException, # Authentication failures
     NotFoundException,       # Resource not found
@@ -330,7 +321,7 @@ except APIException as e:
 ### Submit a Machine Learning Training Job
 
 ```python
-from client import Task
+from mlops import Task
 
 task = Task()
 
@@ -339,16 +330,16 @@ result = task.submit(
     cluster_id=1,
     script="""#!/bin/bash
 #SBATCH --gres=gpu:1
-#SBATCH --cpus-per-task=8
-#SBATCH --mem=32GB
+#SBATCH --cpus-per-task=2
+#SBATCH --mem=4GB
 
 python train.py --config config.yaml
 """,
     resources={
-        "cpus_per_task": 8,
-        "memory": "32GB",
+        "cpus_per_task": 2,
+        "memory": "4GB",
         "gres": "gpu:1",
-        "time": "4-00:00:00",  # 4 days
+        "time": "1-00:00:00",  # 1 days
         "partition": "gpu"
     }
 )
@@ -359,8 +350,8 @@ 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
+from mlops import Task
+from mlops.api.client.models.task_status import TaskStatus
 import time
 
 task = Task()
@@ -380,8 +371,8 @@ while True:
 ### List and Filter Tasks
 
 ```python
-from client import Task
-from client.api.client.models.task_status import TaskStatus
+from mlops import Task
+from mlops.api.client.models.task_status import TaskStatus
 
 task = Task()
 

{mlops_python_sdk-0.0.1 → mlops_python_sdk-1.0.1}/README.md

@@ -1,6 +1,6 @@
 # MLOps Python SDK
 
-[MLOps](https://mlops.cloud) Python SDK for XCloud Service API. Manage and execute tasks with confidence.
+[MLOps](https://xcloud-service.com) Python SDK for XCloud Service API. Manage and execute tasks with confidence.
 
 ## Installation
 
@@ -14,9 +14,9 @@ pip install mlops-python-sdk
 
 ### 1. Setup Authentication
 
-You can authenticate using either an API Key or an Access Token.
+You can authenticate using either an API Key.
 
-#### Option 1: API Key (Recommended for programmatic access)
+#### 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)
@@ -27,18 +27,11 @@ 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
+from mlops import Task, ConnectionConfig
+from mlops.api.client.models.task_status import TaskStatus
 
 # Initialize Task client (uses environment variables by default)
 task = Task()
@@ -94,7 +87,7 @@ The `Task` class provides a high-level interface for managing tasks.
 #### Initialization
 
 ```python
-from client import Task, ConnectionConfig
+from mlops import Task, ConnectionConfig
 
 # Using environment variables
 task = Task()
@@ -102,7 +95,6 @@ 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
@@ -197,7 +189,7 @@ tasks = task.list(
 **Example:**
 
 ```python
-from client.api.client.models.task_status import TaskStatus
+from mlops.api.client.models.task_status import TaskStatus
 
 # List all running tasks
 running_tasks = task.list(status=TaskStatus.RUNNING)
@@ -236,7 +228,7 @@ task.cancel(task_id=12345, cluster_id=1)
 Task status values for filtering:
 
 ```python
-from client.api.client.models.task_status import TaskStatus
+from mlops.api.client.models.task_status import TaskStatus
 
 TaskStatus.PENDING      # Task is pending
 TaskStatus.QUEUED       # Task is queued
@@ -255,7 +247,6 @@ TaskStatus.CREATED      # Task was created
 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`)
@@ -265,7 +256,7 @@ The SDK reads configuration from environment variables:
 You can also configure the connection programmatically:
 
 ```python
-from client import ConnectionConfig
+from mlops import ConnectionConfig
 
 config = ConnectionConfig(
     domain="api.example.com",
@@ -281,7 +272,7 @@ config = ConnectionConfig(
 The SDK provides specific exception types:
 
 ```python
-from client.exceptions import (
+from mlops.exceptions import (
     APIException,           # General API errors
     AuthenticationException, # Authentication failures
     NotFoundException,       # Resource not found
@@ -305,7 +296,7 @@ except APIException as e:
 ### Submit a Machine Learning Training Job
 
 ```python
-from client import Task
+from mlops import Task
 
 task = Task()
 
@@ -314,16 +305,16 @@ result = task.submit(
     cluster_id=1,
     script="""#!/bin/bash
 #SBATCH --gres=gpu:1
-#SBATCH --cpus-per-task=8
-#SBATCH --mem=32GB
+#SBATCH --cpus-per-task=2
+#SBATCH --mem=4GB
 
 python train.py --config config.yaml
 """,
     resources={
-        "cpus_per_task": 8,
-        "memory": "32GB",
+        "cpus_per_task": 2,
+        "memory": "4GB",
         "gres": "gpu:1",
-        "time": "4-00:00:00",  # 4 days
+        "time": "1-00:00:00",  # 1 days
         "partition": "gpu"
     }
 )
@@ -334,8 +325,8 @@ 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
+from mlops import Task
+from mlops.api.client.models.task_status import TaskStatus
 import time
 
 task = Task()
@@ -355,8 +346,8 @@ while True:
 ### List and Filter Tasks
 
 ```python
-from client import Task
-from client.api.client.models.task_status import TaskStatus
+from mlops import Task
+from mlops.api.client.models.task_status import TaskStatus
 
 task = Task()
 

{mlops_python_sdk-0.0.1 → mlops_python_sdk-1.0.1}/mlops/__init__.py

@@ -1,5 +1,5 @@
 """
-XClient Python SDK for accessing XCloud Service API.
+MLOps Python SDK for accessing MLOps API.
 
 This package provides a client library for interacting with the XCloud Service API.
 """
@@ -10,7 +10,7 @@ from .connection_config import (
     ProxyTypes,
 )
 from .exceptions import (
-    XClientException,
+    MLOpsException,
     TimeoutException,
     NotFoundException,
     AuthenticationException,
@@ -29,7 +29,7 @@ __all__ = [
     "ConnectionConfig",
     "ProxyTypes",
     # Exceptions
-    "XClientException",
+    "MLOpsException",
     "TimeoutException",
     "NotFoundException",
     "AuthenticationException",

mlops_python_sdk-1.0.1/mlops/api/client/api/storage/get_storage_presign_download.py

@@ -0,0 +1,175 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.error_response import ErrorResponse
+from ...models.get_storage_presign_download_response_200 import GetStoragePresignDownloadResponse200
+from ...types import UNSET, Response
+
+
+def _get_kwargs(
+    *,
+    key: str,
+) -> dict[str, Any]:
+    params: dict[str, Any] = {}
+
+    params["key"] = key
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/storage/presign_download",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[ErrorResponse, GetStoragePresignDownloadResponse200]]:
+    if response.status_code == 200:
+        response_200 = GetStoragePresignDownloadResponse200.from_dict(response.json())
+
+        return response_200
+    if response.status_code == 400:
+        response_400 = ErrorResponse.from_dict(response.json())
+
+        return response_400
+    if response.status_code == 500:
+        response_500 = ErrorResponse.from_dict(response.json())
+
+        return response_500
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[ErrorResponse, GetStoragePresignDownloadResponse200]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient,
+    key: str,
+) -> Response[Union[ErrorResponse, GetStoragePresignDownloadResponse200]]:
+    """Get presigned URL for file download
+
+     Generates a presigned URL for downloading a file from S3.
+
+    Args:
+        key (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[ErrorResponse, GetStoragePresignDownloadResponse200]]
+    """
+
+    kwargs = _get_kwargs(
+        key=key,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    key: str,
+) -> Optional[Union[ErrorResponse, GetStoragePresignDownloadResponse200]]:
+    """Get presigned URL for file download
+
+     Generates a presigned URL for downloading a file from S3.
+
+    Args:
+        key (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[ErrorResponse, GetStoragePresignDownloadResponse200]
+    """
+
+    return sync_detailed(
+        client=client,
+        key=key,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    key: str,
+) -> Response[Union[ErrorResponse, GetStoragePresignDownloadResponse200]]:
+    """Get presigned URL for file download
+
+     Generates a presigned URL for downloading a file from S3.
+
+    Args:
+        key (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[ErrorResponse, GetStoragePresignDownloadResponse200]]
+    """
+
+    kwargs = _get_kwargs(
+        key=key,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+    key: str,
+) -> Optional[Union[ErrorResponse, GetStoragePresignDownloadResponse200]]:
+    """Get presigned URL for file download
+
+     Generates a presigned URL for downloading a file from S3.
+
+    Args:
+        key (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[ErrorResponse, GetStoragePresignDownloadResponse200]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            key=key,
+        )
+    ).parsed

mlops_python_sdk-1.0.1/mlops/api/client/api/storage/get_storage_presign_upload.py

@@ -0,0 +1,175 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.error_response import ErrorResponse
+from ...models.get_storage_presign_upload_response_200 import GetStoragePresignUploadResponse200
+from ...types import UNSET, Response
+
+
+def _get_kwargs(
+    *,
+    filename: str,
+) -> dict[str, Any]:
+    params: dict[str, Any] = {}
+
+    params["filename"] = filename
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/storage/presign_upload",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[ErrorResponse, GetStoragePresignUploadResponse200]]:
+    if response.status_code == 200:
+        response_200 = GetStoragePresignUploadResponse200.from_dict(response.json())
+
+        return response_200
+    if response.status_code == 400:
+        response_400 = ErrorResponse.from_dict(response.json())
+
+        return response_400
+    if response.status_code == 500:
+        response_500 = ErrorResponse.from_dict(response.json())
+
+        return response_500
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[ErrorResponse, GetStoragePresignUploadResponse200]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient,
+    filename: str,
+) -> Response[Union[ErrorResponse, GetStoragePresignUploadResponse200]]:
+    """Get presigned URL for file upload
+
+     Generates a presigned URL for uploading a file to S3.
+
+    Args:
+        filename (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[ErrorResponse, GetStoragePresignUploadResponse200]]
+    """
+
+    kwargs = _get_kwargs(
+        filename=filename,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    filename: str,
+) -> Optional[Union[ErrorResponse, GetStoragePresignUploadResponse200]]:
+    """Get presigned URL for file upload
+
+     Generates a presigned URL for uploading a file to S3.
+
+    Args:
+        filename (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[ErrorResponse, GetStoragePresignUploadResponse200]
+    """
+
+    return sync_detailed(
+        client=client,
+        filename=filename,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    filename: str,
+) -> Response[Union[ErrorResponse, GetStoragePresignUploadResponse200]]:
+    """Get presigned URL for file upload
+
+     Generates a presigned URL for uploading a file to S3.
+
+    Args:
+        filename (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[ErrorResponse, GetStoragePresignUploadResponse200]]
+    """
+
+    kwargs = _get_kwargs(
+        filename=filename,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+    filename: str,
+) -> Optional[Union[ErrorResponse, GetStoragePresignUploadResponse200]]:
+    """Get presigned URL for file upload
+
+     Generates a presigned URL for uploading a file to S3.
+
+    Args:
+        filename (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[ErrorResponse, GetStoragePresignUploadResponse200]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            filename=filename,
+        )
+    ).parsed

mlops_python_sdk-1.0.1/mlops/api/client/api/tasks/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""