介绍

安装

VeADK安装方式

从 PyPI 安装

您可以直接使用 Python 包管理工具 pipPyPI 平台 来安装 veadk-python

pip install veadk-python

从源码构建

下载源码至本地

将VeADK的代码包从Github下载到本地:

Terminal
git clone https://github.com/volcengine/veadk-python.git

cd veadk-python

配置 uv 环境

本项目使用 uv 进行构建,了解如何(安装 uv)。

创建 uv 虚拟环境:

Terminal
# 选择 3.10 及以上版本
uv venv --python 3.10

激活 uv 虚拟环境:

source .venv/bin/activate

安装 VeADK

Terminal
uv pip install .

# 或以本地可编辑模式安装
# uv pip install -e .

贡献代码

我们接受对veadk-python的能力扩展或 BUG 修复贡献,请按照以下方式进行代码贡献:

从源码构建、安装

请参考这里

开发

依照开发规范文档进行开发(即将上线)。

安装 pre-commit

pre-commit 将在您提交代码前进行一系列检查,例如代码格式规范检查、密钥泄漏检查等。未使用 pre-commit 检查过的提交将不会通过 Github 中的 CI/CD 工作流检查,这意味着代码将不会被合并。

Terminal
pip install pre-commit

pre-commit install .

等待代码审查

您提交的代码贡献将会在 1 至 2 个工作日内被处理。