gmicloud 0.1.5__py3-none-any.whl → 0.1.7__py3-none-any.whl

gmicloud/_internal/_manager/serve_command_utils.py

@@ -0,0 +1,121 @@
+import shlex
+import os
+import logging
+
+logger = logging.getLogger(__name__)
+
+def parse_server_command(cmd_str: str) -> tuple[str, dict, dict]:
+    """ 
+    parse server command
+    Maybe their are more than two types of server command
+    if not found, we can add more parse function
+    """
+    if "vllm serve" in cmd_str:
+        return ("vllm", *parse_server_vllm_command(cmd_str))
+    elif "sglang.launch_server" in cmd_str:
+        return ("sglang", *parse_server_sglang_command(cmd_str))
+    else:
+        raise ValueError(f"Unknown serve command: {cmd_str}")
+
+def extract_env_and_args(tokens: list) -> tuple[dict, list]:
+    """
+    Extract environment variables from the tokens list.
+    and add the params or flags to environment variables
+    """
+    env_vars = {}
+    while tokens and '=' in tokens[0] and not tokens[0].startswith('--'):
+        key, value = tokens.pop(0).split('=', 1)
+        env_vars[key] = value
+    for k, v in env_vars.items():
+        os.environ[k] = v
+    return env_vars, tokens
+
+def parse_flags_and_args(tokens: list) -> dict:
+    """ 
+    parse flags and args 
+    include three types --flag=value and --flag value annd --flag
+    """
+    result = {}
+    i = 0
+    while i < len(tokens):
+        token = tokens[i]
+        if token.startswith('--'):
+            if '=' in token:
+                key, value = token[2:].split('=', 1)
+                result[key] = value.strip("'\"")
+            elif i + 1 < len(tokens) and not tokens[i + 1].startswith('--'):
+                result[token[2:]] = tokens[i + 1].strip("'\"")
+                i += 1
+            elif i + 1 < len(tokens) and not tokens[i + 1].startswith('-'):
+                result[token[1:]] = tokens[i + 1].strip("'\"")
+                i += 1
+            else:
+                result[token[2:]] = True
+        else:
+            logger.warning(f"Ignoring unknown token: {token}")
+        i += 1
+    return result
+
+def parse_server_vllm_command(cmd_str: str) -> tuple[dict, dict]:
+    """ parse vllm command"""
+    tokens = shlex.split(cmd_str)
+    result = {}
+
+    # 提取环境变量
+    env_vars, tokens = extract_env_and_args(tokens)
+    if env_vars:
+        result["env_vars"] = env_vars
+
+    # vllm serve + model
+    if tokens[:2] != ['vllm', 'serve']:
+        raise ValueError("Invalid vllm serve command format. Example: vllm serve <model path>")
+
+    if len(tokens) < 3:
+        raise ValueError("Missing model path in vllm serve command. Example: vllm serve <model path>")
+    
+    model_path = tokens[2]
+    result["model-path"] = model_path
+    
+    flags = parse_flags_and_args(tokens[3:])
+    result.update(flags)
+    return (env_vars, result)
+
+def parse_server_sglang_command(cmd_str: str) -> tuple[dict, dict]:
+    """ parse sglang command"""
+    tokens = shlex.split(cmd_str)
+    result = {}
+
+    # 提取环境变量
+    env_vars, tokens = extract_env_and_args(tokens)
+    if env_vars:
+        result["env_vars"] = env_vars
+    # python3 -m sglang.launch_server
+    if tokens[:3] != ['python3', '-m', 'sglang.launch_server'] and tokens[:3] != ['python', '-m', 'sglang.launch_server']:
+        raise ValueError("Invalid sglang command format. Example: python3 -m sglang.launch_server")
+
+    flags = parse_flags_and_args(tokens[3:])
+    result.update(flags)
+    return (env_vars, result)
+
+def extract_gpu_num_from_serve_command(serve_args_dict: dict) -> int:
+    """ extract gpu num from serve command """            
+    cmd_tp_size = 1
+    cmd_dp_size = 1
+    if "tensor-parallel-size" in serve_args_dict:
+        cmd_tp_size = int(serve_args_dict["tensor-parallel-size"])
+    elif "tp" in serve_args_dict:
+        cmd_tp_size = int(serve_args_dict["tp"])
+    elif "tp-size" in serve_args_dict:
+        cmd_tp_size = int(serve_args_dict["tp-size"])
+    if "data-parallel-size" in serve_args_dict:
+        cmd_dp_size = int(serve_args_dict["data-parallel-size"])
+    elif "dp" in serve_args_dict:
+        cmd_dp_size = int(serve_args_dict["dp"])
+    elif "dp-size" in serve_args_dict:
+        cmd_dp_size = int(serve_args_dict["dp-size"])
+    if "pipeline_parallel_size" in serve_args_dict or "pp" in serve_args_dict:
+        raise ValueError("Pipeline parallel size is not supported.")
+    cmd_gpu_num = cmd_tp_size * cmd_dp_size
+    if cmd_gpu_num > 8:
+        raise ValueError("Only support up to 8 GPUs for single task replica.")
+    return cmd_gpu_num

gmicloud/_internal/_models.py

@@ -1,8 +1,8 @@
-from typing import Optional, List
+from typing import Optional, List, Union
 from datetime import datetime
 
 from pydantic import BaseModel
-from gmicloud._internal._enums import BuildStatus, TaskStatus, TaskEndpointStatus
+from gmicloud._internal._enums import BuildStatus, TaskStatus, TaskEndpointStatus, ModelParameterType
 
 
 class BigFileMetadata(BaseModel):
@@ -22,9 +22,13 @@ class ArtifactMetadata(BaseModel):
     user_id: Optional[str] = ""  # The user ID associated with this artifact.
     artifact_name: Optional[str] = ""  # Name of the artifact.
     artifact_description: Optional[str] = ""  # Description of the artifact.
-    artifact_tags: Optional[List[str]] = ""  # Comma-separated tags for categorizing the artifact.
+    artifact_tags: Optional[List[str]] = None  # Changed from List[str] with default to Optional[List[str]]
     artifact_volume_path: Optional[str] = ""  # Path to the volume where the artifact is stored.
     artifact_template_id: Optional[str] = ""  # The template ID used to create this artifact.
+    artifact_icon_link: Optional[str] = ""  # Link to the icon for the artifact.
+    is_public: Optional[bool] = False  # Indicates if the artifact is public.
+    org_id: Optional[str] = ""  # Organization ID associated with this artifact.
+    update_by: Optional[str] = ""  # User ID who last updated the artifact.
 
 
 class ArtifactData(BaseModel):
@@ -43,6 +47,29 @@ class ArtifactData(BaseModel):
     update_at: Optional[datetime]  # Timestamp when the artifact was last updated.
 
 
+class EnvParameter(BaseModel):
+    """
+    Environment parameter for an artifact.
+    """
+    key: str  # Key for the environment parameter.
+    value: str  # Value for the environment parameter.
+
+
+class ArtifactDetails(BaseModel):
+    """
+    Additional details for an artifact.
+    """
+    model_description: Optional[str] = ""  # Description of the model.
+
+
+class ArtifactParameters(BaseModel):
+    """
+    Parameters for an artifact.
+    """
+    env_parameters: Optional[List[EnvParameter]] = None  # Environment parameters.
+    model_parameters: Optional[List["ModelParameter"]] = None  # Model parameters.
+
+
 class Artifact(BaseModel):
     """
     Representation of an artifact, including its data and metadata.
@@ -53,6 +80,7 @@ class Artifact(BaseModel):
     build_status: Optional[BuildStatus] = None  # Status of the artifact build (e.g., in progress, succeeded, failed).
     artifact_data: Optional[ArtifactData] = None  # Data associated with the artifact.
     artifact_metadata: Optional[ArtifactMetadata] = None  # Metadata describing the artifact.
+    artifact_parameters: Optional[ArtifactParameters] = None  # Parameters for the artifact.
     big_files_metadata: Optional[List[BigFileMetadata]] = None  # Metadata for large files associated with the artifact.
 
 
@@ -69,7 +97,12 @@ class CreateArtifactRequest(BaseModel):
     """
     artifact_name: str  # The name of the artifact to create.
     artifact_description: Optional[str] = ""  # Description of the artifact.
-    artifact_tags: Optional[List[str]] = None  # Tags for the artifact, separated by commas.
+    artifact_tags: Optional[List[str]] = None  # Tags for the artifact.
+    deployment_type: Optional[str] = ""  # Deployment type
+    template_id: Optional[str] = ""  # Template ID
+    env_parameters: Optional[List["EnvParameter"]] = None  # Environment parameters.
+    model_description: Optional[str] = ""  # Description of the model.
+    model_parameters: Optional[List["ModelParameter"]] = None  # Parameters for the artifact.
 
 
 class CreateArtifactResponse(BaseModel):
@@ -78,9 +111,10 @@ class CreateArtifactResponse(BaseModel):
     """
     artifact_id: str  # ID of the newly created artifact.
     upload_link: str  # URL to upload the artifact data.
+    artifact_icon_link: Optional[str] = ""  # Link to the icon for the artifact.
 
 
-class GetBigFileUploadUrlRequest(BaseModel):
+class ResumableUploadLinkRequest(BaseModel):
     """
     Request to generate a pre-signed URL for uploading large files.
     """
@@ -89,7 +123,7 @@ class GetBigFileUploadUrlRequest(BaseModel):
     file_type: Optional[str] = ""  # MIME type of the file.
 
 
-class GetBigFileUploadUrlResponse(BaseModel):
+class ResumableUploadLinkResponse(BaseModel):
     """
     Response containing a pre-signed upload URL for large files.
     """
@@ -97,6 +131,13 @@ class GetBigFileUploadUrlResponse(BaseModel):
     upload_link: str  # Pre-signed upload URL for the file.
 
 
+class RebuildArtifactRequest(BaseModel):
+    """
+    Request object for rebuilding an artifact.
+    """
+    artifact_id: str  # ID of the artifact to rebuild.
+
+
 class RebuildArtifactResponse(BaseModel):
     """
     Response object after rebuilding an artifact.
@@ -105,6 +146,91 @@ class RebuildArtifactResponse(BaseModel):
     build_status: BuildStatus  # Status of the artifact build (e.g., in progress, succeeded, failed).
 
 
+class EndpointInfo(BaseModel):
+    """
+    Additional information about the task endpoint.
+    """
+    endpoint_status: Optional[TaskEndpointStatus] = None  # Current status of the task (e.g., running, stopped).
+    endpoint_url: Optional[str] = ""  # URL for accessing the task endpoint.
+
+
+class GetAllArtifactsWithEndpointsResponse(BaseModel):
+    """
+    Response containing a list of all artifacts with their endpoints.
+    """
+    artifact_id: str  # Unique identifier for the artifact.
+    artifact_data: Optional[ArtifactData] = None  # Data associated with the artifact.
+    artifact_metadata: Optional[ArtifactMetadata] = None  # Metadata describing the artifact.
+    artifact_details: Optional[ArtifactDetails] = None  # Additional details about the artifact.
+    artifact_parameters: Optional[ArtifactParameters] = None  # Parameters for the artifact.
+    big_files_metadata: Optional[List[BigFileMetadata]] = None  # Metadata for large files.
+    endpoints: Optional[List[EndpointInfo]] = None  # Endpoints associated with the artifact.
+
+
+class GetArtifactResponse(BaseModel):
+    """
+    Response containing the details of an artifact.
+    """
+    artifact_id: str  # Unique identifier for the artifact.
+    artifact_link: Optional[str] = ""  # Link to access the artifact.
+    artifact_resource: Optional[str] = ""  # Resource associated with the artifact.
+    build_file_name: Optional[str] = ""  # Name of the file used for the build.
+    build_status: Optional[str] = ""  # Status of the artifact build.
+    artifact_metadata: Optional[ArtifactMetadata] = None  # Metadata describing the artifact.
+    artifact_parameters: Optional[ArtifactParameters] = None  # Parameters for the artifact.
+    big_files_metadata: Optional[List[BigFileMetadata]] = None  # Metadata for large files.
+
+
+class GetPublicArtifactsResponse(BaseModel):
+    """
+    Response containing public artifact details.
+    """
+    artifact_id: str  # Unique identifier for the artifact.
+    artifact_data: Optional[ArtifactData] = None  # Data associated with the artifact.
+    artifact_metadata: Optional[ArtifactMetadata] = None  # Metadata describing the artifact.
+    artifact_details: Optional[ArtifactDetails] = None  # Additional details about the artifact.
+    artifact_parameters: Optional[ArtifactParameters] = None  # Parameters for the artifact.
+    endpoints: Optional[List[EndpointInfo]] = None  # Endpoints associated with the artifact.
+
+
+class UpdateArtifactRequestBody(BaseModel):
+    """
+    Request object for updating an artifact.
+    """
+    artifact_name: Optional[str] = ""  # The name of the artifact.
+    artifact_description: Optional[str] = ""  # Description of the artifact.
+    artifact_tags: Optional[List[str]] = None  # Tags for the artifact.
+    env_parameters: Optional[List[EnvParameter]] = None  # Environment parameters.
+    model_description: Optional[str] = ""  # Description of the model.
+    model_parameters: Optional[List["ModelParameter"]] = None  # Parameters for the artifact.
+    need_update_icon: Optional[bool] = False  # Whether to update the artifact icon.
+
+
+class UpdateArtifactResponse(BaseModel):
+    """
+    Response object after updating an artifact.
+    """
+    artifact_id: str  # ID of the updated artifact.
+    status: str  # Status of the update operation.
+    artifact_icon_link: Optional[str] = ""  # Link to the icon for the artifact.
+
+
+class GetTemplatesResponse(BaseModel):
+    """
+    Response containing a list of artifact templates.
+    """
+    artifact_templates: list["Template"]  # List of artifact templates.
+
+
+class Template(BaseModel):
+    """
+    Template for creating an artifact.
+    """
+    template_id: str  # Unique identifier for the artifact template.
+    template_data: Optional["TemplateData"] = None  # Data for the artifact template.
+    template_metadata: Optional["TemplateMetadata"] = None  # Metadata for the artifact template.
+
+
 class DeleteArtifactResponse(BaseModel):
     """
     Response object after deleting an artifact.
@@ -131,22 +257,6 @@ class DeleteBigfileResponse(BaseModel):
     status: Optional[str] = ""  # Status of the deletion process.
 
 
-class GetPublicTemplatesResponse(BaseModel):
-    """
-    Response containing a list of artifact templates.
-    """
-    artifact_templates: list["ArtifactTemplate"]  # List of artifact templates.
-
-
-class ArtifactTemplate(BaseModel):
-    """
-    Template for creating an artifact.
-    """
-    template_id: str  # Unique identifier for the artifact template.
-    template_data: Optional["TemplateData"] = None  # Data for the artifact template.
-    template_metadata: Optional["TemplateMetadata"] = None  # Metadata for the artifact template.
-
-
 class TemplateMetadata(BaseModel):
     """
     Metadata for an artifact template.
@@ -157,6 +267,8 @@ class TemplateMetadata(BaseModel):
     is_public: Optional[bool] = False  # Indicates if the template is public.
     update_at: Optional[str] = None  # Timestamp when the template was last updated.
     update_by: Optional[str] = ""  # ID of the user who last updated the template.
+    status: Optional[str] = ""  # Status of the template.
+
 
 class TemplateData(BaseModel):
     """
@@ -165,13 +277,28 @@ class TemplateData(BaseModel):
     description: Optional[str] = ""  # Description of the artifact template.
     icon_link: Optional[str] = ""  # Link to the icon for the artifact template.
     image_link: Optional[str] = ""  # Link to the image for the artifact template.
+    model_parameters: Optional[List["ModelParameter"]] = None  # Parameters for the artifact template.
     name: Optional[str] = ""  # Name of the artifact template.
     ray: Optional["RayContent"] = None  # Template for Ray-based artifacts.
     resources: Optional["ResourcesTemplate"] = None  # Resource allocation template.
     tags: Optional[List[str]] = None  # Tags associated with the artifact template.
     volume_path: Optional[str] = ""  # Path to the volume where the artifact is stored.
+    env_parameters: Optional[List["EnvParameter"]] = None  # Added missing field
 
 
+class ModelParameter(BaseModel):
+    """
+    Parameter for an artifact template.
+    """
+    category: Optional[str] = ""  # Category of the parameter.
+    display_name: Optional[str] = ""  # Display name of the parameter.
+    key: Optional[str] = ""  # Key for the parameter.
+    max: Optional[float] = 0  # Maximum value for the parameter.
+    min: Optional[float] = 0  # Minimum value for the parameter.
+    step: Optional[float] = 0  # Step value for the parameter.
+    type: Optional[ModelParameterType] = ModelParameterType.TEXT  # Type of the parameter (e.g., numeric, bool, text).
+    value: Optional[Union[int, float, bool, str]] = ""  # Default value for the parameter.
+
 class RayContent(BaseModel):
     deployment_name: Optional[str] = ""  # Name of the deployment.
     file_path: Optional[str] = ""  # Path to the task file in storage.
@@ -188,8 +315,9 @@ class CreateArtifactFromTemplateRequest(BaseModel):
     """
     Request object to create a new artifact from a template.
     """
-    user_id: str  # The user ID creating the artifact.
+    # user_id: str  # The user ID creating the artifact.
     artifact_template_id: str  # The ID of the artifact template to use.
+    env_parameters: Optional[List["EnvParameter"]] = None  # Environment parameters.
 
 
 class CreateArtifactFromTemplateResponse(BaseModel):
@@ -234,7 +362,6 @@ class RayTaskConfig(BaseModel):
     Configuration settings for Ray tasks.
     """
     artifact_id: Optional[str] = ""  # Associated artifact ID.
-    ray_version: Optional[str] = ""  # Version of Ray used.
     ray_cluster_image: Optional[str] = ""  # Docker image for the Ray cluster.
     file_path: Optional[str] = ""  # Path to the task file in storage.
     deployment_name: Optional[str] = ""  # Name of the deployment.
@@ -282,20 +409,13 @@ class TaskConfig(BaseModel):
     """
     Configuration data for a task.
     """
+    task_name: Optional[str] = ""  # Name of the task.
     ray_task_config: Optional[RayTaskConfig] = None  # Configuration for a Ray-based task.
     task_scheduling: Optional[TaskScheduling] = None  # Scheduling configuration for the task.
     create_timestamp: Optional[int] = 0  # Timestamp when the task was created.
     last_update_timestamp: Optional[int] = 0  # Timestamp when the task was last updated.
 
 
-class EndpointInfo(BaseModel):
-    """
-    Additional information about the task endpoint.
-    """
-    endpoint_status: Optional[TaskEndpointStatus] = None  # Current status of the task (e.g., running, stopped).
-    endpoint_url: Optional[str] = ""  # URL for accessing the task endpoint.
-
-
 class UserPreference(BaseModel):
     """
     User preference for a task.
@@ -313,8 +433,8 @@ class Task(BaseModel):
     config: Optional[TaskConfig] = None  # Configuration data for the task.
     endpoint_info: Optional[EndpointInfo] = None  # Additional information about the task endpoint.
     cluster_endpoints: Optional[List[EndpointInfo]] = None  # Endpoints for the task cluster.
-    task_status: Optional[TaskStatus] = ""  # Status of the task.
-    readiness_status: Optional[str] = ""  # Readiness status of the task.
+    task_status: Optional[TaskStatus] = None  # Status of the task.
+    readiness_status: Optional[str] = None  # Readiness status of the task.
     user_preference: Optional[UserPreference] = None  # User preference for the task.