intellif-aihub 0.1.5__py3-none-any.whl → 0.1.7__py3-none-any.whl

aihub/models/quota_schedule_management.py

@@ -1,239 +1,285 @@
 from __future__ import annotations
 
+from enum import IntEnum
 from typing import List, Optional
 
 from pydantic import BaseModel, Field
 
 
 class Env(BaseModel):
-    key: str
-    value: str
+    """环境变量"""
+    key: str = Field(description="变量名")
+    value: str = Field(description="变量值")
 
 
 class Sku(BaseModel):
-    cpu: int
-    gpu: int
-    memory: int
+    """sku"""
+    cpu: int = Field(description="CPU数")
+    gpu: int = Field(description="GPU数")
+    memory: int = Field(description="内存GiB")
 
 
 class VirtualCluster(BaseModel):
-    id: int
-    name: str
-    gpu_type: str = Field(alias="gpu_type")
-    label: str
-    sku: Sku
+    """虚拟集群"""
+    id: int = Field(description="ID")
+    name: str = Field(description="名称")
+    gpu_type: str = Field(alias="gpu_type", description="GPU类型，A800/4090/3090/2080")
+    label: str = Field(description="标签")
+    sku: Sku = Field(description="SKU")
 
 
 class Storage(BaseModel):
-    id: int
-    name: str
-    path: str
-    server_path: str = Field(alias="server_path")
-    server_host: str = Field(alias="server_host")
-    server_type: str = Field(alias="server_type")
-    permission: str
-    description: str
+    """存储"""
+    id: int = Field(description="存储ID")
+    name: str = Field(description="存储名称")
+    path: str = Field(description="挂载路径")
+    server_path: str = Field(alias="server_path", description="服务器路径")
+    server_host: str = Field(alias="server_host", description="服务器地址")
+    server_type: str = Field(alias="server_type", description="服务器类型")
+    permission: str = Field(description="权限")
+    description: str = Field(description="说明")
 
 
 class Category(BaseModel):
-    id: int
-    name: str
+    """分类"""
+    id: int = Field(description="分类ID")
+    name: str = Field(description="分类名称")
 
 
 class Project(BaseModel):
-    id: int
-    name: str
-    description: str
+    """项目"""
+    id: int = Field(description="项目ID")
+    name: str = Field(description="项目名称")
+    description: str = Field(description="项目描述")
 
 
 class User(BaseModel):
-    id: int
-    name: str
+    """用户"""
+    id: int = Field(description="用户ID")
+    name: str = Field(description="用户名")
 
 
 class SourceTask(BaseModel):
-    id: int
-    name: str
+    """来源任务"""
+    id: int = Field(description="来源任务ID")
+    name: str = Field(description="来源任务名称")
+
+
+class TaskStatus(IntEnum):
+    """任务状态"""
+    Waiting = 1
+    Running = 2
+    Success = 3
+    Failed = 4
+    Stopped = 5
+    Stopping = 6
+
+
+class PreemptPolicy(IntEnum):
+    """抢占策略"""
+    WAIT = 1  # 等待任务完成
+    STOP = 2  # 停止任务
 
 
 class CreateTaskRequest(BaseModel):
-    priority: int
-    framework: str
-    name: str
-    description: Optional[str] = None
-    command: Optional[str] = None
-    image: str
-    virtual_cluster_id: int = Field(alias="virtual_cluster_id")
-    sku_cnt: int = Field(alias="sku_cnt")
-    enable_ssh: Optional[bool] = Field(False, alias="enable_ssh")
-    envs: Optional[List[Env]] = Field(default_factory=list, alias="envs")
-    storage_ids: Optional[List[int]] = Field(default_factory=list, alias="storage_ids")
-    instances: int
-    use_ib_network: Optional[bool] = Field(False, alias="use_ib_network")
-    always_pull_image: Optional[bool] = Field(False, alias="always_pull_image")
-    shm: Optional[int] = None
-    category_id: int = Field(alias="category_id")
-    project_id: int = Field(alias="project_id")
-    estimate_run_time: Optional[int] = Field(None, alias="estimate_run_time")
-    is_vip: Optional[bool] = Field(False, alias="is_vip")
-    preempt_policy: Optional[int] = Field(None, alias="preempt_policy")
-    vip_node_names: Optional[List[str]] = Field(default_factory=list, alias="vip_node_names")
-    enable_reschedule: Optional[bool] = Field(False, alias="enable_reschedule")
+    """创建配额任务请求"""
+    priority: int = Field(description="优先级，1-低优先级，2-高优先级")
+    framework: str = Field(description="训练框架，如PyTorchJob/MpiJobMpiRun/MpiJobDeepspeed")
+    name: str = Field(description="任务名称")
+    description: Optional[str] = Field(None, description="任务描述")
+    command: Optional[str] = Field(None, description="命令")
+    image: str = Field(description="镜像")
+    virtual_cluster_id: int = Field(alias="virtual_cluster_id", description="虚拟集群ID")
+    sku_cnt: int = Field(alias="sku_cnt", description="sku数量")
+    enable_ssh: Optional[bool] = Field(False, alias="enable_ssh", description="SSH开启")
+    envs: Optional[List[Env]] = Field(default_factory=list, description="环境变量")
+    storage_ids: Optional[List[int]] = Field(default_factory=list, alias="storage_ids", description="挂载存储")
+    instances: int = Field(description="实例数")
+    use_ib_network: Optional[bool] = Field(False, alias="use_ib_network", description="是否使用IB网络")
+    always_pull_image: Optional[bool] = Field(False, alias="always_pull_image", description="每次拉镜像")
+    shm: Optional[int] = Field(None, description="共享内存MB")
+    category_id: int = Field(alias="category_id", description="分类ID")
+    project_id: int = Field(alias="project_id", description="项目ID")
+    estimate_run_time: Optional[int] = Field(None, alias="estimate_run_time", description="预计运行时长(s)")
+    enable_reschedule: Optional[bool] = Field(False, alias="enable_reschedule", description="启用失败重调度")
+
+    model_config = {"use_enum_values": True}
 
 
 class CreateTaskResponse(BaseModel):
-    id: int
+    """创建配额任务返回"""
+    id: int = Field(description="任务ID")
 
 
 class Task(BaseModel):
-    id: int
-    priority: int
-    mtp_id: int = Field(alias="mtp_id")
-    framework: str
-    name: str
-    description: str
-    command: str
-    image: str
-    virtual_cluster: VirtualCluster = Field(alias="virtual_cluster")
-    sku_cnt: int = Field(alias="sku_cnt")
-    enable_ssh: bool = Field(alias="enable_ssh")
-    envs: Optional[List[Env]] = Field(default_factory=list, alias="envs")
-    storages: Optional[List[Storage]] = Field(default_factory=list, alias="storages")
-    instances: int
-    created_at: int = Field(alias="created_at")
-    username: str
-    user_id: int = Field(alias="user_id")
-    namespace: str
-    res_name: str = Field(alias="res_name")
-    status: int
-    use_ib_network: bool = Field(alias="use_ib_network")
-    always_pull_image: bool = Field(alias="always_pull_image")
-    shm: int
-    category: Category
-    project: Project
-    avg_gpu_util: float = Field(alias="avg_gpu_util")
-    finished_at: int = Field(alias="finished_at")
-    started_at: int = Field(alias="started_at")
-    estimate_run_time: int = Field(alias="estimate_run_time")
-    is_vip: bool = Field(alias="is_vip")
-    cluster_partition: str = Field(alias="cluster_partition")
-    preempt_policy: int = Field(alias="preempt_policy")
-    vip_node_names: Optional[List[str]] = Field(None, alias="vip_node_names")
-    stop_op_user: Optional[User] = Field(None, alias="stop_op_user")
-    use_new_log: bool = Field(alias="use_new_log")
-    is_quota_schedule: bool = Field(alias="is_quota_schedule")
-    enable_reschedule: bool = Field(alias="enable_reschedule")
-    remain_schedule_cnt: int = Field(alias="remain_schedule_cnt")
-    source_task: Optional[SourceTask] = Field(None, alias="source_task")
+    """配额任务详情"""
+    id: int = Field(description="任务ID")
+    priority: int = Field(description="优先级，1-低优先级，2-高优先级")
+    mtp_id: int = Field(alias="mtp_id", description="训练平台关联ID")
+    framework: str = Field(description="框架")
+    name: str = Field(description="名称")
+    description: str = Field(description="描述")
+    command: str = Field(description="命令")
+    image: str = Field(description="镜像")
+    virtual_cluster: VirtualCluster = Field(alias="virtual_cluster", description="虚拟集群")
+    sku_cnt: int = Field(alias="sku_cnt", description="sku数量")
+    enable_ssh: bool = Field(alias="enable_ssh", description="SSH开启")
+    envs: Optional[List[Env]] = Field(default_factory=list, description="环境变量")
+    storages: Optional[List[Storage]] = Field(default_factory=list, description="挂载存储")
+    instances: int = Field(description="实例数")
+    created_at: int = Field(alias="created_at", description="创建时间")
+    username: str = Field(description="提交人")
+    user_id: int = Field(alias="user_id", description="提交人ID")
+    namespace: str = Field(description="K8s Namespace")
+    res_name: str = Field(alias="res_name", description="K8s 资源名")
+    status: TaskStatus = Field(description="状态")
+    use_ib_network: bool = Field(alias="use_ib_network", description="IB网络")
+    always_pull_image: bool = Field(alias="always_pull_image", description="每次拉镜像")
+    shm: int = Field(description="共享内存MB")
+    category: Category = Field(description="分类")
+    project: Project = Field(description="项目")
+    avg_gpu_util: float = Field(alias="avg_gpu_util", description="平均GPU利用率")
+    finished_at: int = Field(alias="finished_at", description="结束时间")
+    started_at: int = Field(alias="started_at", description="开始时间")
+    estimate_run_time: int = Field(alias="estimate_run_time", description="预计运行时长")
+    cluster_partition: str = Field(alias="cluster_partition", description="集群分区")
+    preempt_policy: PreemptPolicy = Field(alias="preempt_policy", description="抢占策略")
+    stop_op_user: Optional[User] = Field(None, alias="stop_op_user", description="停止操作人")
+    use_new_log: bool = Field(alias="use_new_log", description="新版日志")
+    is_quota_schedule: bool = Field(alias="is_quota_schedule", description="是否配额调度")
+    enable_reschedule: bool = Field(alias="enable_reschedule", description="允许重调度")
+    remain_schedule_cnt: int = Field(alias="remain_schedule_cnt", description="剩余可调度次数")
+    source_task: Optional[SourceTask] = Field(None, alias="source_task", description="来源任务")
+
+    model_config = {"use_enum_values": True}
 
 
 class ListTasksRequest(BaseModel):
-    page_size: int = Field(20, alias="page_size")
-    page_num: int = Field(1, alias="page_num")
-    user_id: Optional[int] = Field(None, alias="user_id")
-    name: Optional[str] = None
-    virtual_cluster_id: Optional[int] = Field(None, alias="virtual_cluster_id")
-    status: Optional[int] = None
-    category_id: Optional[int] = Field(None, alias="category_id")
-    project_id: Optional[int] = Field(None, alias="project_id")
-    priority: Optional[int] = None
+    """查询任务列表请求"""
+    page_size: int = Field(20, alias="page_size", description="每页数量")
+    page_num: int = Field(1, alias="page_num", description="当前页码")
+    user_id: Optional[int] = Field(None, alias="user_id", description="用户过滤")
+    name: Optional[str] = Field(None, description="名称过滤")
+    virtual_cluster_id: Optional[int] = Field(None, alias="virtual_cluster_id", description="虚拟集群过滤")
+    status: Optional[TaskStatus] = Field(None, description="状态过滤")
+    category_id: Optional[int] = Field(None, alias="category_id", description="分类过滤")
+    project_id: Optional[int] = Field(None, alias="project_id", description="项目过滤")
+    priority: Optional[int] = Field(None, description="优先级过滤")
+
+    model_config = {"use_enum_values": True}
 
 
 class ListTasksResponse(BaseModel):
-    total: int
-    page_size: int = Field(alias="page_size")
-    page_num: int = Field(alias="page_num")
-    data: List[Task] = Field(default_factory=list)
+    """查询任务列表返回"""
+    total: int = Field(description="总条数")
+    page_size: int = Field(alias="page_size", description="每页数量")
+    page_num: int = Field(alias="page_num", description="当前页码")
+    data: List[Task] = Field(default_factory=list, description="任务列表")
 
 
 class Pod(BaseModel):
-    id: int
-    namespace: str
-    name: str
-    status: str
-    created_at: int = Field(alias="created_at")
-    started_at: int = Field(alias="started_at")
-    finished_at: int = Field(alias="finished_at")
-    host_ip: str = Field(alias="host_ip")
-    node_name: str = Field(alias="node_name")
-    ssh_port: int = Field(alias="ssh_port")
-    ssh_info: str = Field(alias="ssh_info")
-    use_new_log: bool = Field(alias="use_new_log")
+    """任务Pod"""
+    id: int = Field(description="ID")
+    namespace: str = Field(description="Namespace")
+    name: str = Field(description="名称")
+    status: str = Field(description="状态")
+    created_at: int = Field(alias="created_at", description="创建时间")
+    started_at: int = Field(alias="started_at", description="启动时间")
+    finished_at: int = Field(alias="finished_at", description="结束时间")
+    host_ip: str = Field(alias="host_ip", description="宿主机IP")
+    node_name: str = Field(alias="node_name", description="节点名")
+    ssh_port: int = Field(alias="ssh_port", description="SSH端口")
+    ssh_info: str = Field(alias="ssh_info", description="SSH连接信息")
+    use_new_log: bool = Field(alias="use_new_log", description="是否使用新版日志")
 
 
 class ListTaskPodsRequest(BaseModel):
-    page_size: int = Field(20, alias="page_size")
-    page_num: int = Field(1, alias="page_num")
+    """查询任务Pod列表请求"""
+    page_size: int = Field(20, alias="page_size", description="每页数量")
+    page_num: int = Field(1, alias="page_num", description="当前页码")
 
 
 class ListTaskPodsResponse(BaseModel):
-    total: int
-    page_size: int = Field(alias="page_size")
-    page_num: int = Field(alias="page_num")
-    data: List[Pod] = Field(default_factory=list)
+    """查询任务Pod列表返回"""
+    total: int = Field(description="总条数")
+    page_size: int = Field(alias="page_size", description="每页数量")
+    page_num: int = Field(alias="page_num", description="页码")
+    data: List[Pod] = Field(default_factory=list, description="Pod 列表")
 
 
 class PodLogInfo(BaseModel):
-    name: str
-    url: str
+    """pod日志信息"""
+    name: str = Field(description="日志名称")
+    url: str = Field(description="URL")
 
 
 class GetTaskPodLogsNewResponse(BaseModel):
-    logs: List[PodLogInfo]
+    """查询任务Pod日志返回"""
+    logs: List[PodLogInfo] = Field(description="日志列表")
 
 
 class GetTaskPodSpecResponse(BaseModel):
-    spec: str
+    """查询任务Pod Spec返回"""
+    spec: str = Field(description="Pod YAML Spec")
 
 
 class GetTaskPodEventsResponse(BaseModel):
-    events: str
+    """查询任务Pod Event返回"""
+    events: str = Field(description="事件内容")
 
 
 class MachineOverview(BaseModel):
-    high: int
-    low: int
-    free: int
+    """机器概况"""
+    high: int = Field(description="高优先级")
+    low: int = Field(description="低优先级")
+    free: int = Field(description="空闲")
 
 
 class HighPrioritySummary(BaseModel):
-    group_id: int = Field(alias="group_id")
-    group_name: str = Field(alias="group_name")
-    used: int
-    total: int
+    """高优先级概况"""
+    group_id: int = Field(alias="group_id", description="组ID")
+    group_name: str = Field(alias="group_name", description="组名称")
+    used: int = Field(description="已用GPU")
+    total: int = Field(description="总GPU")
 
 
 class MetricsOverview(BaseModel):
-    vc_id: int = Field(alias="vc_id")
-    vc_name: str = Field(alias="vc_name")
-    machine: MachineOverview
-    high_priority: List[HighPrioritySummary] = Field(alias="high_priority")
+    """指标概况"""
+    vc_id: int = Field(alias="vc_id", description="虚拟集群ID")
+    vc_name: str = Field(alias="vc_name", description="虚拟集群名称")
+    machine: MachineOverview = Field(description="机器概览")
+    high_priority: List[HighPrioritySummary] = Field(alias="high_priority", description="高优先级概览")
 
 
 class GetMetricsOverviewRequest(BaseModel):
-    page_size: int = Field(20, alias="page_size")
-    page_num: int = Field(1, alias="page_num")
+    """查询指标概况请求"""
+    page_size: int = Field(20, alias="page_size", description="每页数量")
+    page_num: int = Field(1, alias="page_num", description="当前页码")
 
 
 class GetMetricsOverviewResponse(BaseModel):
-    total: int
-    page_size: int = Field(alias="page_size")
-    page_num: int = Field(alias="page_num")
-    data: List[MetricsOverview] = Field(default_factory=list)
+    """查询指标概况返回"""
+    total: int = Field(description="总条数")
+    page_size: int = Field(alias="page_size", description="每页数量")
+    page_num: int = Field(alias="page_num", description="当前页码")
+    data: List[MetricsOverview] = Field(default_factory=list, description="指标列表")
 
 
 class TaskUser(BaseModel):
-    user_id: int = Field(alias="user_id")
-    username: str
+    """任务用户"""
+    user_id: int = Field(alias="user_id", description="用户ID")
+    username: str = Field(description="用户名")
 
 
 class ListTaskUsersRequest(BaseModel):
-    page_size: int = Field(20, alias="page_size")
-    page_num: int = Field(1, alias="page_num")
+    """查询任务用户列表请求"""
+    page_size: int = Field(20, alias="page_size", description="每页数量")
+    page_num: int = Field(1, alias="page_num", description="当前页码")
 
 
 class ListTaskUsersResponse(BaseModel):
-    total: int
-    page_size: int = Field(alias="page_size")
-    page_num: int = Field(alias="page_num")
-    data: List[TaskUser] = Field(default_factory=list)
+    """查询任务用户列表返回"""
+    total: int = Field(description="总条数")
+    page_size: int = Field(alias="page_size", description="每页数量")
+    page_num: int = Field(alias="page_num", description="页码")
+    data: List[TaskUser] = Field(default_factory=list, description="用户列表")

aihub/models/tag_resource_management.py

@@ -1,6 +1,3 @@
-# !/usr/bin/env python
-# -*-coding:utf-8 -*-
-
 from __future__ import annotations
 
 from typing import List, Optional
@@ -9,42 +6,51 @@ from pydantic import BaseModel, Field
 
 
 class Project(BaseModel):
-    id: int
-    name: str
+    """项目"""
+    id: int = Field(description="项目ID")
+    name: str = Field(description="项目名称")
 
 
 class ProjectListData(BaseModel):
-    data: List[Project]
+    """项目列表数据"""
+    data: List[Project] = Field(description="项目列表")
 
 
 class SelectProjectsResponse(BaseModel):
-    data: List[Project]
+    """选择项目返回"""
+    data: List[Project] = Field(description="项目列表")
 
 
 class SkuBrief(BaseModel):
-    id: int
-    description: str
-    cpu: int
-    memory: int
-    gpu_type: int = Field(alias="gpu_type")
-    gpu_memory: int = Field(alias="gpu_memory")
-    network: int
-    created_at: int = Field(alias="created_at")
+    """SKU信息"""
+    id: int = Field(description="SKU ID")
+    description: str = Field(description="SKU 描述")
+    cpu: int = Field(description="CPU 核数")
+    memory: int = Field(description="内存 GiB")
+    gpu_type: int = Field(alias="gpu_type", description="GPU类型，1-A800，2-4090，3-3090，4-2080，5-None")
+    gpu_memory: int = Field(alias="gpu_memory", description="GPU 显存 GiB")
+    network: int = Field(description="网络，0-Other，1-ROCE，2-IB")
+    created_at: int = Field(alias="created_at", description="创建时间戳（ms）")
 
 
 class VirtualClusterBrief(BaseModel):
-    id: int
-    name: str
-    uuid: str
-    sku: Optional[SkuBrief] = None
-    created_at: int = Field(alias="created_at")
+    """虚拟集群信息"""
+    id: int = Field(description="虚拟集群ID")
+    name: str = Field(description="虚拟集群名称")
+    uuid: str = Field(description="虚拟集群UUID")
+    sku: Optional[SkuBrief] = Field(None, description="SKU")
+    created_at: int = Field(alias="created_at", description="创建时间戳（ms）")
 
 
 class SelectVirtualClustersRequest(BaseModel):
-    user_id: int = Field(alias="user_id")
-    module_type: Optional[int] = Field(None, alias="module_type")
-    new_module_type: Optional[str] = Field(None, alias="new_module_type")
+    """选择虚拟集群请求"""
+    user_id: int = Field(alias="user_id", description="用户ID")
+    module_type: Optional[int] = Field(None, alias="module_type",
+                                       description="模块类型 (int)，0-部署，1-训练，2-工作流，3-配额调度")
+    new_module_type: Optional[str] = Field(None, alias="new_module_type",
+                                           description="新版模块类型 (字符串)，仅前端使用")
 
 
 class SelectVirtualClustersResponse(BaseModel):
-    data: Optional[List[VirtualClusterBrief]] = Field(default_factory=list)
+    """选择虚拟集群返回"""
+    data: Optional[List[VirtualClusterBrief]] = Field(default_factory=list, description="虚拟集群列表")