Ultralytics HUB-SDK

欢迎访问Ultralytics HUB-SDK 文档！如果您希望将强大的机器学习工具和服务集成到您的Python 应用程序中，那您就来对地方了。无论您是人工智能爱好者、经验丰富的机器学习实践者，还是希望利用Ultralytics 服务功能的软件开发人员，我们的 SDK 都能让您轻松高效地完成工作。

我们友好而专业的文档将指导您从安装到掌握 HUB-SDK 的整个过程。让我们一起进入Ultralytics 生态系统，在您的项目中充分发挥其强大功能！

从哪里开始

准备好开始使用 HUB-SDK 了？我们的快速入门指南提供了在Python 环境中运行 SDK 的直接路径。

访问以下网站，推进您的开发并简化您的设置：快速入门。

从 PyPI 安装

通过 PyPI 获取最新稳定版 HUB-SDK。只需在终端/shell 中执行以下命令，即可将 SDK 无缝添加到您的Python 项目中：

pip install hub-sdk

运行该命令后，将下载并安装 SDK，从而在应用程序中释放Ultralytics 服务的功能。

初始化 HUBClient

与Ultralytics 服务的集成始于初始化一个 HUBClient 对象。这一关键步骤在您的代码和我们的应用程序接口之间架起了一座桥梁，它需要适当的凭证进行身份验证。您可以选择标准的 API 密钥方法，也可以使用电子邮件和密码。让我们一起来设置吧！🚀

选项 1：使用 API 密钥

要使用简单的 API 密钥，请像这样用密钥准备一个字典：

# Replace <YOUR-API-KEY> with the actual key provided to you by Ultralytics.
credentials = {"api_key": "<YOUR-API-KEY>"}

通过使用 API 密钥，您可以选择一种适用于编程访问的通用身份验证方法。它非常适合将密钥直接集成到框架中，以实现快速、安全的服务交互。

选项 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 验证

使用 API 密钥验证使用电子邮件和密码验证

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 平台提供的大量服务连接起来。有了安全的身份验证详细信息，您就可以尽情探索指尖上的各种功能了！

恭喜您安装了Ultralytics HUB-SDK！现在，您已经做好充分准备，可以开始将最先进的机器学习服务集成到您的应用程序中。探索我们的更多文档，了解特定 API 的使用指南，如果遇到任何障碍，请咨询我们的社区论坛。祝您编码愉快，愿您的项目借助Ultralytics 的力量茁壮成长！🌟