跳至内容

快速入门：安装 HUB-SDK

您好，欢迎光临！🎉如果你想快速、轻松地集成Ultralytics 服务，那你就来对地方了。我们的 HUB-SDK 安装指南旨在通过清晰的分步说明，帮助您快速启动和运行。无论您是经验丰富的开发人员还是刚刚起步的新手，我们的目标都是为您提供简单明了的安装过程。拿上你最喜欢的饮料，让我们一起踏上安装之旅吧！

先决条件

在进入安装的核心部分之前，让我们先确保我们已经准备好了所需的所有工具。一个顺利的安装过程始于正确的设置，所以下面是你应该准备好的工具：

  • Python:要使用 HUB-SDK，您的计算机必须安装Python 。如果系统中尚未安装，请从python.org下载最新版本。

  • Git（可选）：虽然 Git 不是安装 HUB-SDK 的必选项，但如果你想直接从源代码中获取最新、最强大的功能，强烈建议使用 Git。Git 可从git-scm.com 获取。

有了这些先决条件，您就可以进入安装阶段了。

安装方法

根据需要，您可以选择两种主要方法来安装 HUB-SDK。以下是每种方法的优点：

从 PyPI 安装

如果你追求稳定性和安装的简便性，那么从 PyPI 获取最新稳定版的 HUB-SDK 是个不错的选择。下面是如何使用 pip（Python 的软件包安装程序）进行安装的方法：

pip install hub-sdk

运行该命令将提取稳定版 HUB-SDK，并直接安装到Python 环境中。这是开始使用 HUB-SDK 的最快途径。

初始化 HUBClient

安装完成后，就可以使用 HUBClient 了。HUBClient 将是您连接Ultralytics 生态系统的网关。下面有两种验证和使用客户端的方法。

选项 A：使用 API 密钥进行身份验证

对于那些喜欢使用 API 密钥以提高简便性和安全性的用户，下面是设置方法：

from hub_sdk import HUBClient

credentials = {"api_key": "<YOUR-API-KEY>"}

将Ultralytics 提供的实际应用程序接口密钥替换为 <YOUR-API-KEY>.当应用程序接口需要安全密钥才能访问时，这是首选方法。

选项 B：使用电子邮件/密码对进行身份验证

如果需要使用电子邮件/密码组合，也很简单：

from hub_sdk import HUBClient

credentials = {"email": "<YOUR-EMAIL>", "password": "<YOUR-PASSWORD>"}

更换 <YOUR-EMAIL> 和 <YOUR-PASSWORD> 使用您的登录凭据。这种方法更为传统，但同样强大。

最后，使用选定的凭证方法创建 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 服务执行各种操作！

一切就绪！您现在已经安装了 HUB-SDK，并拥有一个初始化的 HUBClient。从这里开始，您就可以开始使用Ultralytics 生态系统提供的丰富功能了。在您的项目中充分利用 HUB-SDK 的强大功能和灵活性，浏览文档以了解您还能做些什么，如果遇到任何问题，只需点击一下鼠标，我们友好的支持团队就会为您提供帮助。祝您编码愉快！


评论