Ultralytics HUB-SDK
欢迎阅读 Ultralytics HUB-SDK 文档！如果您希望将强大的机器学习工具和服务集成到您的 Python 应用程序中，那么您来对地方了。无论您是 AI 爱好者、经验丰富的机器学习从业者，还是希望利用 Ultralytics 服务功能的软件开发人员，我们的 SDK 都能让您轻松高效地完成任务。
我们友好而专业的文档将指导您从安装到掌握 HUB-SDK。让我们深入了解并开始在您的项目中充分利用 Ultralytics 生态系统的强大功能！
从哪里开始
准备好开始使用 HUB-SDK 了吗？我们的快速入门指南提供了一条在您的 Python 环境中启动并运行 SDK 的直接途径。
- 访问 Quickstart 页面，加速您的开发并简化您的设置。
从 PyPI 安装
通过 PyPI 获得最新稳定版本的 HUB-SDK。只需在您的终端或 shell 中执行以下命令，即可无缝地将 SDK 添加到您的 Python 项目中：
pip install hub-sdk
运行此命令后，将下载并安装 SDK，从而在您的应用程序中解锁 Ultralytics 服务的各项功能。
初始化 HUBClient
与 Ultralytics 服务的集成始于初始化一个 HUBClient 对象。这个关键步骤在您的代码和我们的 API 之间建立了一座桥梁，并且需要适当的凭据进行身份验证。您可以选择标准的 API 密钥方法，或者使用您的电子邮件和密码。让我们一起设置它！🚀
选项 1：使用 API 密钥
要利用 API 密钥的简易性，请准备一个包含您的密钥的字典，如下所示：
# Replace <YOUR-API-KEY> with the actual key provided to you by Ultralytics.
credentials = {"api_key": "<YOUR-API-KEY>"}
使用 API 密钥是一种常见的身份验证方法，适用于程序化访问。它非常适合将密钥直接集成到框架中以实现快速、安全的服务交互的场景。该 HUBClient 类 继承身份验证功能 来自 Auth 类。
选项 2：使用电子邮件和密码
想要使用您的账户凭据？请配置 HUBClient 在凭据字典中使用您的电子邮件和密码：
# Replace <YOUR-EMAIL> with your email address and <YOUR-PASSWORD> with your password.
credentials = {"email": "<YOUR-EMAIL>", "password": "<YOUR-PASSWORD>"}
如果您正在寻找传统的登录体验或旨在利用与您的 Ultralytics 帐户相关的个性化功能，则使用您的电子邮件和密码是一个方便的选择。
整合在一起
现在您的凭据已准备就绪，请启动您的 HUBClient:
HUB SDK 身份验证
from hub_sdk import HUBClient
credentials = {"api_key": "<YOUR-API-KEY>"} # api key
client = HUBClient(credentials)
from hub_sdk import HUBClient
credentials = {"email": "<YOUR-EMAIL>", "password": "<YOUR-PASSWORD>"} # email and password
client = HUBClient(credentials)
这关键的代码行创建了一个新的实例 HUBClient，将您连接到 Ultralytics 平台提供的广阔服务领域。有了安全就位的身份验证详细信息，您就可以开始探索触手可及的功能了！The login 方法 处理身份验证 使用提供的凭据。
HUB-SDK 功能
Ultralytics HUB-SDK 提供了一系列与您的机器学习项目交互的功能。以下是您可以执行的一些关键操作：
- 数据集管理: 使用以下方式与数据集交互
dataset方法，它返回一个Datasets对象。您可以 获取, 创建, 更新, 删除, 列表, 获取数据集访问的 URL和 上传 数据集。 - 数据集列表: 使用以下方式获取数据集列表
dataset_list方法，它返回一个DatasetList对象。 - 项目管理：通过获取、创建、更新或删除来管理您的项目。
恭喜您成功设置 Ultralytics HUB-SDK！现在，您已准备好将最先进的机器学习服务集成到您的应用程序中。请浏览我们的其他文档，以获取有关使用特定 API 的指导，如果您遇到任何障碍，请咨询我们的社区论坛。祝您编码愉快，并祝您的项目在 Ultralytics 的强大功能下蓬勃发展！🌟
