Kili Python SDK 安装与配置指南

1. 项目基础介绍

Kili Python SDK 是 Kili 平台的 Python 客户端。Kili 平台致力于通过高质量训练数据的创建，推动机器学习的数据驱动方法。它提供了协作式的数据标注工具和 API，使得可靠数据集的构建和模型训练之间的迭代变得快速而高效。

主要编程语言：Python

2. 项目使用的关键技术和框架

• Python：作为主要的编程语言，Python 提供了易于理解和使用的语法，适合快速开发。
• RESTful API：Kili Python SDK 通过与 Kili 平台的 RESTful API 交互，实现数据的查询和操作。
• JSON：数据交换格式，用于配置项目和标注任务。

3. 项目安装和配置的准备工作与详细步骤

准备工作

• 确保你的系统已经安装了 Python 3.8 或更高版本。
• 准备一个文本编辑器，用于编辑环境变量。

安装步骤

步骤 1：安装 Python

如果你的系统中没有安装 Python，你需要先安装它。可以从 Python 官网下载并安装适合你操作系统的 Python 版本。

步骤 2：创建虚拟环境（可选）

创建一个虚拟环境可以帮助你管理项目依赖，避免与其他项目冲突。

python -m venv venv
source venv/bin/activate  # 在 Windows 下使用 `venv\Scripts\activate`

步骤 3：安装 Kili Python SDK

在虚拟环境中，使用 pip 命令安装 Kili Python SDK。

pip install kili

步骤 4：配置 KILI_API_KEY

在安装 SDK 之后，你需要在你的系统环境变量中配置 KILI_API_KEY，这个 API 密钥可以从 Kili 平台获取。

在 Unix-like 系统中，打开你的 shell 配置文件（如 .bashrc 或 .zshrc），并添加以下行：

export KILI_API_KEY='<你的 API 密钥>'

在 Windows 系统中，你可以通过以下命令设置环境变量：

set KILI_API_KEY=<你的 API 密钥>

确保替换 <你的 API 密钥> 为你的实际 API 密钥。

步骤 5：验证安装

最后，你可以通过以下命令来验证是否正确安装了 Kili Python SDK：

from kili.client import Kili
kili = Kili()
print(kili.version)  # 这将打印出当前安装的 SDK 版本

如果能够成功打印出版本信息，那么你的 Kili Python SDK 已经安装并配置成功了。

现在你可以开始使用 Kili Python SDK 来创建项目、导入数据、标注数据和导出结果了。