gmicloud 0.1.4__tar.gz → 0.1.5__tar.gz

{gmicloud-0.1.4 → gmicloud-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: gmicloud
-Version: 0.1.4
+Version: 0.1.5
 Summary: GMI Cloud Python SDK
 Author-email: GMI <gmi@gmitec.net>
 License: MIT
@@ -13,17 +13,11 @@ Description-Content-Type: text/markdown
 # GMICloud SDK (Beta)
 
 ## Overview
+Before you start: Our service and GPU resource is currenly invite-only so please contact our team (getstarted@gmicloud.ai) to get invited if you don't have one yet.
 
-Before you start: Our service and GPU resource is currenly invite-only so please contact our team (
-getstarted@gmicloud.ai) to get invited if you don't have one yet.
+The GMI Inference Engine SDK provides a Python interface for deploying and managing machine learning models in production environments. It allows users to create model artifacts, schedule tasks for serving models, and call inference APIs easily.
 
-The GMI Inference Engine SDK provides a Python interface for deploying and managing machine learning models in
-production environments. It allows users to create model artifacts, schedule tasks for serving models, and call
-inference APIs easily.
-
-This SDK streamlines the process of utilizing GMI Cloud capabilities such as deploying models with Kubernetes-based Ray
-services, managing resources automatically, and accessing model inference endpoints. With minimal setup, developers can
-focus on building ML solutions instead of infrastructure.
+This SDK streamlines the process of utilizing GMI Cloud capabilities such as deploying models with Kubernetes-based Ray services, managing resources automatically, and accessing model inference endpoints. With minimal setup, developers can focus on building ML solutions instead of infrastructure.
 
 ## Features
 
@@ -51,6 +45,7 @@ Set the following environment variables:
 export GMI_CLOUD_CLIENT_ID=<YOUR_CLIENT_ID>
 export GMI_CLOUD_EMAIL=<YOUR_EMAIL>
 export GMI_CLOUD_PASSWORD=<YOUR_PASSWORD>
+export GMI_CLOUD_API_KEY=<YOUR_API_KEY>
 ```
 
 ### Option 2: Passing Credentials as Parameters
@@ -73,7 +68,7 @@ python -m venv venv
 source venv/bin/activate
 
 pip install -r requirements.txt
-python -m examples.<example_name>
+python -m examples.create_task_from_artifact_template.py
 ```
 
 ### 2. Create a Task from an Artifact Template
@@ -114,11 +109,12 @@ First, you’ll retrieve all templates and create an artifact based on the desir
 ```python
 from gmicloud import *
 
+
 def create_artifact_from_template(client: Client) -> str:
     artifact_manager = client.artifact_manager
 
     # Get all artifact templates
-    templates = artifact_manager.get_artifact_templates()
+    templates = artifact_manager.get_public_templates()
     for template in templates:
         if template.artifact_template_id == "qwen_2.5_14b_instruct_template_001":
             # Create an artifact from a template
@@ -235,10 +231,10 @@ password: Optional[str] = ""
 
 ## Notes & Troubleshooting
 
-Ensure Credentials are Correct: Double-check your environment variables or parameters passed into the Client object.
-Artifact Status: It may take a few minutes for an artifact or task to transition to the "running" state.
-Inference Endpoint Readiness: Use the task endpoint only after the task status changes to "running".
-Default OpenAI Key: By default, the OpenAI API base URL is derived from the endpoint provided by GMI.
+* Ensure Credentials are Correct: Double-check your environment variables or parameters passed into the Client object.
+* Artifact Status: It may take a few minutes for an artifact or task to transition to the "running" state.
+* Inference Endpoint Readiness: Use the task endpoint only after the task status changes to "running".
+* Default OpenAI Key: By default, the OpenAI API base URL is derived from the endpoint provided by GMI.
 
 ## Contributing
 

{gmicloud-0.1.4 → gmicloud-0.1.5}/README.md

@@ -1,17 +1,11 @@
 # GMICloud SDK (Beta)
 
 ## Overview
+Before you start: Our service and GPU resource is currenly invite-only so please contact our team (getstarted@gmicloud.ai) to get invited if you don't have one yet.
 
-Before you start: Our service and GPU resource is currenly invite-only so please contact our team (
-getstarted@gmicloud.ai) to get invited if you don't have one yet.
+The GMI Inference Engine SDK provides a Python interface for deploying and managing machine learning models in production environments. It allows users to create model artifacts, schedule tasks for serving models, and call inference APIs easily.
 
-The GMI Inference Engine SDK provides a Python interface for deploying and managing machine learning models in
-production environments. It allows users to create model artifacts, schedule tasks for serving models, and call
-inference APIs easily.
-
-This SDK streamlines the process of utilizing GMI Cloud capabilities such as deploying models with Kubernetes-based Ray
-services, managing resources automatically, and accessing model inference endpoints. With minimal setup, developers can
-focus on building ML solutions instead of infrastructure.
+This SDK streamlines the process of utilizing GMI Cloud capabilities such as deploying models with Kubernetes-based Ray services, managing resources automatically, and accessing model inference endpoints. With minimal setup, developers can focus on building ML solutions instead of infrastructure.
 
 ## Features
 
@@ -39,6 +33,7 @@ Set the following environment variables:
 export GMI_CLOUD_CLIENT_ID=<YOUR_CLIENT_ID>
 export GMI_CLOUD_EMAIL=<YOUR_EMAIL>
 export GMI_CLOUD_PASSWORD=<YOUR_PASSWORD>
+export GMI_CLOUD_API_KEY=<YOUR_API_KEY>
 ```
 
 ### Option 2: Passing Credentials as Parameters
@@ -61,7 +56,7 @@ python -m venv venv
 source venv/bin/activate
 
 pip install -r requirements.txt
-python -m examples.<example_name>
+python -m examples.create_task_from_artifact_template.py
 ```
 
 ### 2. Create a Task from an Artifact Template
@@ -102,11 +97,12 @@ First, you’ll retrieve all templates and create an artifact based on the desir
 ```python
 from gmicloud import *
 
+
 def create_artifact_from_template(client: Client) -> str:
     artifact_manager = client.artifact_manager
 
     # Get all artifact templates
-    templates = artifact_manager.get_artifact_templates()
+    templates = artifact_manager.get_public_templates()
     for template in templates:
         if template.artifact_template_id == "qwen_2.5_14b_instruct_template_001":
             # Create an artifact from a template
@@ -223,10 +219,10 @@ password: Optional[str] = ""
 
 ## Notes & Troubleshooting
 
-Ensure Credentials are Correct: Double-check your environment variables or parameters passed into the Client object.
-Artifact Status: It may take a few minutes for an artifact or task to transition to the "running" state.
-Inference Endpoint Readiness: Use the task endpoint only after the task status changes to "running".
-Default OpenAI Key: By default, the OpenAI API base URL is derived from the endpoint provided by GMI.
+* Ensure Credentials are Correct: Double-check your environment variables or parameters passed into the Client object.
+* Artifact Status: It may take a few minutes for an artifact or task to transition to the "running" state.
+* Inference Endpoint Readiness: Use the task endpoint only after the task status changes to "running".
+* Default OpenAI Key: By default, the OpenAI API base URL is derived from the endpoint provided by GMI.
 
 ## Contributing
 

{gmicloud-0.1.4 → gmicloud-0.1.5}/gmicloud/__init__.py

@@ -1,3 +1,6 @@
+import logging
+import os
+
 from ._internal._models import (
     Artifact,
     ArtifactData,
@@ -16,7 +19,8 @@ from ._internal._models import (
 )
 from ._internal._enums import (
     BuildStatus,
-    TaskEndpointStatus
+    TaskEndpointStatus,
+    TaskStatus
 )
 from .client import Client
 
@@ -39,3 +43,10 @@ __all__ = [
     "BuildStatus",
     "TaskEndpointStatus",
 ]
+
+# Configure logging
+log_level = os.getenv("GMI_CLOUD_LOG_LEVEL", "INFO").upper()
+logging.basicConfig(
+    level=log_level,
+    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'
+)

gmicloud-0.1.5/gmicloud/_internal/_client/_artifact_client.py

@@ -0,0 +1,212 @@
+from typing import List
+import logging
+from requests.exceptions import RequestException
+
+from ._http_client import HTTPClient
+from ._iam_client import IAMClient
+from ._decorator import handle_refresh_token
+from .._models import *
+from .._config import ARTIFACT_SERVICE_BASE_URL
+
+logger = logging.getLogger(__name__)
+
+
+class ArtifactClient:
+    """
+    Client for interacting with the Artifact Service API.
+
+    This client provides methods to perform CRUD operations on artifacts,
+    as well as generating signed URLs for uploading large files.
+    """
+
+    def __init__(self, iam_client: IAMClient):
+        """
+        Initializes the ArtifactClient with an HTTPClient configured
+        to communicate with the Artifact Service base URL.
+        """
+        self.client = HTTPClient(ARTIFACT_SERVICE_BASE_URL)
+        self.iam_client = iam_client
+
+    @handle_refresh_token
+    def get_artifact(self, artifact_id: str) -> Optional[Artifact]:
+        """
+        Fetches an artifact by its ID.
+
+        :param artifact_id: The ID of the artifact to fetch.
+        :return: The Artifact object or None if an error occurs.
+        """
+        try:
+            response = self.client.get(
+                "/get_artifact",
+                self.iam_client.get_custom_headers(),
+                {"artifact_id": artifact_id}
+            )
+            return Artifact.model_validate(response) if response else None
+        except (RequestException, ValueError) as e:
+            logger.error(f"Failed to fetch artifact {artifact_id}: {e}")
+            return None
+
+    @handle_refresh_token
+    def get_all_artifacts(self) -> List[Artifact]:
+        """
+        Fetches all artifacts.
+
+        :return: A list of Artifact objects. If an error occurs, returns an empty list.
+        """
+        try:
+            response = self.client.get("/get_all_artifacts", self.iam_client.get_custom_headers())
+            if not response:
+                logger.error("Empty response from /get_all_artifacts")
+                return []
+            return [Artifact.model_validate(item) for item in response]
+        except (RequestException, ValueError) as e:
+            logger.error(f"Failed to fetch all artifacts: {e}")
+            return []
+
+    @handle_refresh_token
+    def create_artifact(self, request: CreateArtifactRequest) -> Optional[CreateArtifactResponse]:
+        """
+        Creates a new artifact in the service.
+
+        :param request: The request object containing artifact details.
+        :return: The response object containing the created artifact details, or None on error.
+        """
+        try:
+            response = self.client.post(
+                "/create_artifact",
+                self.iam_client.get_custom_headers(),
+                request.model_dump()
+            )
+            return CreateArtifactResponse.model_validate(response) if response else None
+        except (RequestException, ValueError) as e:
+            logger.error(f"Failed to create artifact: {e}")
+            return None
+
+    @handle_refresh_token
+    def create_artifact_from_template(self, artifact_template_id: str) -> Optional[CreateArtifactFromTemplateResponse]:
+        """
+        Creates a new artifact in the service.
+
+        :param artifact_template_id: The ID of the artifact template to use.
+        :return: The response object containing the created artifact details or None if an error occurs.
+        """
+        try:
+            response = self.client.post(
+                "/create_artifact_from_template",
+                self.iam_client.get_custom_headers(),
+                {"artifact_template_id": artifact_template_id}
+            )
+            return CreateArtifactFromTemplateResponse.model_validate(response) if response else None
+        except (RequestException, ValueError) as e:
+            logger.error(f"Failed to create artifact from template {artifact_template_id}: {e}")
+            return None
+
+    @handle_refresh_token
+    def rebuild_artifact(self, artifact_id: str) -> Optional[RebuildArtifactResponse]:
+        """
+        Rebuilds an artifact in the service.
+
+        :param artifact_id: The ID of the artifact to rebuild.
+        :return: The response object containing the rebuilt artifact details or None if an error occurs.
+        """
+        try:
+            response = self.client.post(
+                "/rebuild_artifact",
+                self.iam_client.get_custom_headers(),
+                {"artifact_id": artifact_id}
+            )
+            return RebuildArtifactResponse.model_validate(response) if response else None
+        except (RequestException, ValueError) as e:
+            logger.error(f"Failed to rebuild artifact {artifact_id}: {e}")
+            return None
+
+    @handle_refresh_token
+    def delete_artifact(self, artifact_id: str) -> Optional[DeleteArtifactResponse]:
+        """
+        Deletes an artifact by its ID.
+
+        :param artifact_id: The ID of the artifact to delete.
+        :return: The response object containing the deleted artifact details or None if an error occurs.
+        """
+        try:
+            response = self.client.delete(
+                "/delete_artifact",
+                self.iam_client.get_custom_headers(),
+                {"artifact_id": artifact_id}
+            )
+            return DeleteArtifactResponse.model_validate(response) if response else None
+        except (RequestException, ValueError) as e:
+            logger.error(f"Failed to delete artifact {artifact_id}: {e}")
+            return None
+
+    @handle_refresh_token
+    def get_bigfile_upload_url(self, request: GetBigFileUploadUrlRequest) -> Optional[GetBigFileUploadUrlResponse]:
+        """
+        Generates a pre-signed URL for uploading a large file.
+
+        :param request: The request object containing the artifact ID, file name, and file type.
+        :return: The response object containing the pre-signed URL and upload details, or None if an error occurs.
+        """
+        try:
+            response = self.client.post("/get_bigfile_upload_url",
+                                        self.iam_client.get_custom_headers(),
+                                        request.model_dump())
+
+            if not response:
+                logger.error("Empty response from /get_bigfile_upload_url")
+                return None
+
+            return GetBigFileUploadUrlResponse.model_validate(response)
+
+        except (RequestException, ValueError) as e:
+            logger.error(f"Failed to generate upload URL: {e}")
+            return None
+
+    @handle_refresh_token
+    def delete_bigfile(self, request: DeleteBigfileRequest) -> Optional[DeleteBigfileResponse]:
+        """
+        Deletes a large file associated with an artifact.
+
+        :param request: The request object containing the artifact ID and file name.
+        :return: The response object containing the deletion status, or None if an error occurs.
+        """
+        try:
+            response = self.client.delete("/delete_bigfile",
+                                          self.iam_client.get_custom_headers(),
+                                          request.model_dump())
+
+            if not response:
+                logger.error("Empty response from /delete_bigfile")
+                return None
+
+            return DeleteBigfileResponse.model_validate(response)
+
+        except (RequestException, ValueError) as e:
+            logger.error(f"Failed to delete big file: {e}")
+            return None
+
+    @handle_refresh_token
+    def get_public_templates(self) -> List[ArtifactTemplate]:
+        """
+        Fetches all artifact templates.
+
+        :return: A list of ArtifactTemplate objects.
+        :rtype: List[ArtifactTemplate]
+        """
+        try:
+            response = self.client.get("/get_public_templates", self.iam_client.get_custom_headers())
+
+            if not response:
+                logger.error("Empty response received from /get_public_templates API")
+                return []
+
+            try:
+                result = GetPublicTemplatesResponse.model_validate(response)
+                return result.artifact_templates
+            except ValueError as ve:
+                logger.error(f"Failed to validate response data: {ve}")
+                return []
+
+        except RequestException as e:
+            logger.error(f"Request to /get_public_templates failed: {e}")
+            return []

{gmicloud-0.1.4 → gmicloud-0.1.5}/gmicloud/_internal/_client/_http_client.py

@@ -1,8 +1,12 @@
+import logging
+
 import requests
 from .._exceptions import APIError
 from .._exceptions import UnauthorizedError
 from .._constants import *
 
+logger = logging.getLogger(__name__)
+
 
 class HTTPClient:
     """
@@ -51,6 +55,7 @@ class HTTPClient:
         response = None
         try:
             response = requests.request(method, url, params=params, json=data, headers=headers)
+            logger.debug(response.text)
             if response.status_code == 401:
                 raise UnauthorizedError("Access token expired or invalid.")
             elif response.status_code != 200 and response.status_code != 201:
@@ -61,7 +66,6 @@ class HTTPClient:
                 raise APIError(f"HTTP Request failed: {error_message}")
             # Raise for HTTP errors
             response.raise_for_status()
-            print(response.text)
 
         except requests.exceptions.RequestException as e:
             raise APIError(f"HTTP Request failed: {str(e)}")

gmicloud-0.1.5/gmicloud/_internal/_client/_iam_client.py

@@ -0,0 +1,189 @@
+import jwt
+import logging
+from requests.exceptions import RequestException
+
+from ._http_client import HTTPClient
+from .._config import IAM_SERVICE_BASE_URL
+from .._models import *
+from .._constants import CLIENT_ID_HEADER, AUTHORIZATION_HEADER
+
+logger = logging.getLogger(__name__)
+
+
+class IAMClient:
+    """
+    Client for interacting with the IAM Service API.
+    """
+
+    def __init__(self, client_id: str, email: str, password: str):
+        """
+        Initialize IAMClient with client credentials and an IAMClient instance.
+
+        :param client_id: Client ID for login.
+        :param email: Email for login.
+        :param password: Password for login.
+        """
+        self._client_id = client_id
+        self._email = email
+        self._password = password
+        self._access_token = ""
+        self._refresh_token = ""
+        self._user_id = ""
+        self._organization_id = ""
+        self.client = HTTPClient(IAM_SERVICE_BASE_URL)
+
+    def login(self) -> bool:
+        """
+        Logs in a user with the given email and password.
+        Returns True if login is successful, otherwise False.
+        """
+        try:
+            custom_headers = {CLIENT_ID_HEADER: self._client_id}
+            req = AuthTokenRequest(email=self._email, password=self._password)
+            auth_tokens_result = self.client.post("/me/auth-tokens", custom_headers, req.model_dump())
+
+            if not auth_tokens_result:
+                logger.error("Login failed: Received empty response from auth-tokens endpoint")
+                return False
+
+            auth_tokens_resp = AuthTokenResponse.model_validate(auth_tokens_result)
+
+            # Handle 2FA
+            if auth_tokens_resp.is2FARequired:
+                for attempt in range(3):
+                    code = input(f"Attempt {attempt + 1}/3: Please enter the 2FA code: ")
+                    create_session_req = CreateSessionRequest(
+                        type="native", authToken=auth_tokens_resp.authToken, otpCode=code
+                    )
+                    try:
+                        session_result = self.client.post("/me/sessions", custom_headers,
+                                                          create_session_req.model_dump())
+                        if session_result:
+                            break
+                    except RequestException:
+                        logger.warning("Invalid 2FA code, please try again.")
+                        if attempt == 2:
+                            logger.error("Failed to create session after 3 incorrect 2FA attempts.")
+                            return False
+            else:
+                create_session_req = CreateSessionRequest(type="native", authToken=auth_tokens_resp.authToken,
+                                                          otpCode=None)
+                session_result = self.client.post("/me/sessions", custom_headers, create_session_req.model_dump())
+
+            create_session_resp = CreateSessionResponse.model_validate(session_result)
+
+            self._access_token = create_session_resp.accessToken
+            self._refresh_token = create_session_resp.refreshToken
+            self._user_id = self.parse_user_id()
+
+            # Fetch profile to get organization ID
+            profile_result = self.client.get("/me/profile", self.get_custom_headers())
+            if not profile_result:
+                logger.error("Failed to fetch user profile data.")
+                return False
+
+            profile_resp = ProfileResponse.model_validate(profile_result)
+            self._organization_id = profile_resp.organization.id
+
+            return True
+        except (RequestException, ValueError, KeyError) as e:
+            logger.error(f"Login failed due to exception: {e}")
+            return False
+
+    def refresh_token(self) -> bool:
+        """
+        Refreshes the access token. Returns True on success, False otherwise.
+        """
+        try:
+            custom_headers = {CLIENT_ID_HEADER: self._client_id}
+            result = self.client.patch("/me/sessions", custom_headers, {"refreshToken": self._refresh_token})
+
+            if not result:
+                logger.error("Failed to refresh token: Empty response received")
+                return False
+
+            resp = CreateSessionResponse.model_validate(result)
+            self._access_token = resp.accessToken
+            self._refresh_token = resp.refreshToken
+
+            return True
+        except (RequestException, ValueError) as e:
+            logger.error(f"Token refresh failed: {e}")
+            return False
+
+    def create_org_api_key(self, request: CreateAPIKeyRequest) -> Optional[str]:
+        """
+        Creates a new API key for the current user.
+        """
+        try:
+            result = self.client.post(f"/organizations/{self.get_organization_id()}/api-keys",
+                                      self.get_custom_headers(), request.model_dump())
+
+            return CreateAPIKeyResponse.model_validate(result).key if result else None
+        except (RequestException, ValueError) as e:
+            logger.error(f"Failed to create API key: {e}")
+            return None
+
+    def get_org_api_keys(self) -> Optional[GetAPIKeysResponse]:
+        """
+        Fetches all API keys for the current user.
+        """
+        try:
+            result = self.client.get(f"/organizations/{self.get_organization_id()}/api-keys",
+                                     self.get_custom_headers())
+
+            return GetAPIKeysResponse.model_validate(result) if result else None
+        except (RequestException, ValueError) as e:
+            logger.error(f"Failed to retrieve organization API keys: {e}")
+            return None
+
+    def parse_user_id(self) -> str:
+        """
+        Parses the current access token and returns the user ID.
+        """
+        return self.parse_token()["userId"]
+
+    def parse_token(self) -> dict:
+        """
+        Parses the current access token and returns the payload as a dictionary.
+        """
+        return jwt.decode(self._access_token, options={"verify_signature": False})
+
+    def get_access_token(self) -> str:
+        """
+        Gets the current access token.
+        """
+        return self._access_token
+
+    def get_refresh_token(self) -> str:
+        """
+        Gets the current refresh token.
+        """
+        return self._refresh_token
+
+    def get_user_id(self) -> str:
+        """
+        Gets the current user ID.
+        """
+        return self._user_id
+
+    def get_client_id(self) -> str:
+        """
+        Gets the current client ID.
+        """
+        return self._client_id
+
+    def get_organization_id(self) -> str:
+        """
+        Gets the current organization ID.
+        """
+        return self._organization_id
+
+    def get_custom_headers(self) -> dict:
+        """
+        Gets the custom headers for the IAM client.
+        """
+        return {
+            AUTHORIZATION_HEADER: f'Bearer {self._access_token}',
+            CLIENT_ID_HEADER: self._client_id
+        }