volcengine-kit

使用说明

创建客户端

使用之前请确保您已经拥有了火山引擎机器学习平台的IAM子账户，并且已经获取了API访问密钥。IAM用户ID可在 账号管理中查看。如果需要使用客户端向飞书发送消息，请传入对应机器人的密钥。

from volcengine_kit import VolcMLPlatformClient

client = VolcMLPlatformClient(
    access_key_id='your AK',
    secret_access_key='your SK',
    iam_user_id='your IAM user ID',
    bot_app_id='your bot App ID',
    bot_app_secret='your bot App secret',
)

提交机器学习平台自定义任务

task = client.submit_task(
    name='your_task_name',
    enable_range_type='Public',
    image_repo='vemlp-cn-beijing.cr.volces.com/preset-images/python',
    image_tag='3.10',
    commands=[
        'sleep 30',
        'echo hello world',
    ],
    default_qid='your default resource queue ID',
    backup_qids=[
        'backup resource queue ID 0',
        'backup resource queue ID 1',
    ],
    priority=4,
    flavor_id='your_flavor_id',
    vepfs_sub_paths=[
        '/fs_users',
        '/fs_projects',
    ],
    envs=[
        {'name': 'ENV0', 'value': 'test', 'is_private': True},
        {'name': 'ENV1', 'value': 'test', 'is_private': False},
    ],
)

等待任务运行结束

import json

async def execute_task(...):
    # 前置业务逻辑
    ...

    # 提交任务并等待
    try:
        task = client.submit_task(...)
    except Exception as e:
        # 异常处理逻辑
        # 可能导致任务提交失败的原因主要来自于参数不合法
        ...
    else:
        # 等待任务达到终止状态
        await task.finished()

        # 后置业务逻辑
        if task.state in ('Success', 'SuccessHolding'):
            # 任务运行成功
            ...
        else:
            # 任务运行失败或者被终止
            # 发送飞书通知到群聊的示例
            client.send_feishu_message(
                receive_id_type='chat_id',
                receive_id='XXX',
                msg_type='text',
                content=json.dumps(
                    {'text': f'任务[{task.id}]结束，状态[{task.state}]'}
                ),
            )
            ...