Skip to content

Register now for

# Quickstart: Installing Ultralytics HUB-SDK

Welcome! 🎉 This guide provides a step-by-step walkthrough for installing and initializing the Ultralytics HUB-SDK, designed for both seasoned developers and beginners.

## Prerequisites

Before you begin, make sure you have the following:

- Python: Required for working with HUB-SDK. If not already installed, download the latest version from python.org.
- Git (Optional): Recommended for accessing the latest features directly from the source. Get Git from git-scm.com.

## Installation

You can install the HUB-SDK using one of the following methods:

### Install from PyPI

For a stable and easy installation, install the latest release of HUB-SDK from PyPI using `pip`:

    pip install hub-sdk

This command downloads and installs the stable version of HUB-SDK into your Python environment. This is the quickest way to get started.

## Initialize HUBClient

After installation, initialize `HUBClient` to interface with the Ultralytics HUB ecosystem. There are two authentication methods available:

### Option 1: Using an API Key

Use an API key for a simple and secure setup:

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

Replace `<YOUR-API-KEY>` with your actual API key from Ultralytics. This method is preferred for secure API access. You can find or create your API key on your Ultralytics HUB settings page.

### Option 2: Using Email and Password

Alternatively, use an email and password combination:

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

Replace `<YOUR-EMAIL>` and `<YOUR-PASSWORD>` with your Ultralytics login credentials.

### Create HUBClient Object

Create a `HUBClient` object using your chosen authentication method:

HUB SDK Authentication

Authentication with API Key Authentication with Email and Password

    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)

With the `HUBClient` instance initialized, you can now perform various operations using Ultralytics services. The `HUBClient` class extends authentication capabilities and serves as your gateway to interacting with the Ultralytics HUB service. For more details, see the `hub_sdk.hub_client.HUBClient` reference documentation.

You're all set! 🚀 With HUB-SDK installed and `HUBClient` initialized, you can now explore the features of the Ultralytics ecosystem. For further guidance, refer to the Ultralytics HUB-SDK documentation and if you encounter any issues, our support team is ready to assist. Happy coding!

📅 Created 1 year ago ✏️ Updated 1 month ago

## Comments