<br>
<a href="https://www.ultralytics.com/" target="_blank"><img src="https://raw.githubusercontent.com/ultralytics/assets/main/logo/Ultralytics_Logotype_Original.svg" width="320" alt="Ultralytics logo"></a>
# 🚀 Ultralytics HUB-SDK
[](https://github.com/ultralytics/hub-sdk/actions/workflows/ci.yml) <a href="https://discord.com/invite/ultralytics"><img alt="Discord" src="https://img.shields.io/discord/1089800235347353640?logo=discord&logoColor=white&label=Discord&color=blue"></a> <a href="https://community.ultralytics.com/"><img alt="Ultralytics Forums" src="https://img.shields.io/discourse/users?server=https%3A%2F%2Fcommunity.ultralytics.com&logo=discourse&label=Forums&color=blue"></a> <a href="https://reddit.com/r/ultralytics"><img alt="Ultralytics Reddit" src="https://img.shields.io/reddit/subreddit-subscribers/ultralytics?style=flat&logo=reddit&logoColor=white&label=Reddit&color=blue"></a>
Welcome to the Ultralytics HUB-SDK documentation! 📖 Our aim is to guide you through the installation process and help you get started with using HUB-SDK for your machine learning endeavors.
## 🛠 Quickstart: Installing HUB-SDK
Ready to dive into HUB-SDK? Follow these steps to set it up on your machine.
### Prerequisites
Ensure you have the following requirements met before proceeding:
- **Python:** HUB-SDK requires Python. Download and install Python from [python.org](https://www.python.org/downloads/) if it's not already installed on your system.
- **Git (Optional):** If you're looking to install HUB-SDK via the GitHub repository, you'll need Git. Grab Git from [git-scm.com](https://git-scm.com/downloads) if you don't have it.
### Installation Methods
Choose from the following options to install HUB-SDK:
#### Installing from PyPI
[](https://badge.fury.io/py/hub-sdk) [](https://www.pepy.tech/projects/hub-sdk)
For the latest stable release of HUB-SDK, use PyPI by running the following command:
```sh
pip install hub-sdk
```
### 🚀 Usage
Let's begin using the HUB-SDK to perform CRUD operations for Models, Datasets, and Projects.
#### 1. Import HUB-SDK
Start by importing the `HUBClient` from the `hub_sdk` module with `from hub_sdk import HUBClient`.
#### 2. Authenticate with Credentials
Set your credentials using one of the following methods:
##### Using API Key
```python
# Authenticate using an API key
credentials = {"api_key": "YOUR_API_KEY"}
```
or
##### Using Email and Password
```python
# Authenticate using your email and password
credentials = {"email": "YOUR_EMAIL", "password": "YOUR_PASSWORD"}
```
#### 3. Initialize the HUBClient
With your credentials ready, initialize the `HUBClient`:
```python
from hub_sdk import HUBClient
# Initialize the client with your credentials
client = HUBClient(credentials)
```
#### Operations
Below are code snippets demonstrating create, read, update, and delete (CRUD) operations for Projects, Models, and Datasets.
#### Project Operations
Managing projects is simple:
```python
# Manipulate a project with the given ID
project = client.project("PROJECT_ID")
# Create a new project with the specified data
create_project = project.create_project("PROJECT_DATA")
# Update the existing project with new data
update_project = project.update("UPDATE_DATA")
# Delete the project
deleted_project = project.delete()
```
#### Model Operations
Handle models effortlessly:
```python
# Engage with a model using the given ID
model = client.model("MODEL_ID")
# Create a new model providing the necessary data
create_model = model.create_project("MODEL_DATA")
# Update the model using provided data
update_model = model.update("UPDATE_DATA")
# Remove the model from the system
deleted_model = model.delete()
```
#### Dataset Operations
Datasets operations are straightforward:
```python
# Interact with a dataset using the specified ID
dataset = client.dataset("DATASET_ID")
# Establish a new dataset given the data
create_dataset = dataset.create_project("DATASET_DATA")
# Adjust the dataset with updated information
update_dataset = dataset.update("UPDATE_DATA")
# Erase the dataset
deleted_dataset = dataset.delete()
```
## 🚀 Ultralytics HUB
Experience seamless AI with [Ultralytics HUB](https://www.ultralytics.com/hub) ⭐, the all-in-one platform for data visualization, model training, and deployment using YOLO11 🚀. Effortlessly transform images into actionable insights without writing any code. Bring your AI visions to life with our user-friendly [Ultralytics App](https://www.ultralytics.com/app-install) and cutting-edge tools. Start your journey for **Free** today!
<a href="https://www.ultralytics.com/hub" target="_blank">
<img width="100%" src="https://github.com/ultralytics/assets/raw/main/im/ultralytics-hub.png" alt="Ultralytics HUB preview image"></a>
## 💡 Contribute
We're thrilled to have you contribute to Ultralytics' open-source projects! Your support and contributions make a world of difference. Get involved by checking out our [Contributing Guide](https://docs.ultralytics.com/help/contributing/), and share your feedback through our [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey). A massive thank you 🙏 to everyone who contributes!
<a href="https://github.com/ultralytics/yolov5/graphs/contributors">
<img width="100%" src="https://github.com/ultralytics/assets/raw/main/im/image-contributors.png" alt="Ultralytics open-source contributors"></a>
## 📄 License
Ultralytics provides two types of licensing options:
- **AGPL-3.0 License**: An [OSI-approved](https://opensource.org/license) open-source license. Ideal for academics, researchers, and enthusiasts, this license promotes sharing knowledge and collaboration. See the [LICENSE](https://github.com/ultralytics/ultralytics/blob/main/LICENSE) file for details.
- **Enterprise License**: Tailored for commercial applications, this license allows for the integration of Ultralytics software into proprietary products and services. If you're considering using our solutions commercially, please get in touch through [Ultralytics Licensing](https://www.ultralytics.com/license).
## 🤝 Contact
- Submit Ultralytics bug reports and feature requests via [GitHub Issues](https://github.com/ultralytics/hub-sdk/issues).
- Join our [Discord](https://discord.com/invite/ultralytics) for assistance, questions, and discussions with the community and team!
<br>
<div align="center">
<a href="https://github.com/ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-github.png" width="3%" alt="Ultralytics GitHub"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
<a href="https://www.linkedin.com/company/ultralytics/"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-linkedin.png" width="3%" alt="Ultralytics LinkedIn"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
<a href="https://twitter.com/ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-twitter.png" width="3%" alt="Ultralytics Twitter"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
<a href="https://youtube.com/ultralytics?sub_confirmation=1"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-youtube.png" width="3%" alt="Ultralytics YouTube"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
<a href="https://www.tiktok.com/@ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-tiktok.png" width="3%" alt="Ultralytics TikTok"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
<a href="https://ultralytics.com/bilibili"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-bilibili.png" width="3%" alt="Ultralytics BiliBili"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
<a href="https://discord.com/invite/ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-discord.png" width="3%" alt="Ultralytics Discord"></a>
</div>
Raw data
{
"_id": null,
"home_page": null,
"name": "hub-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Ultralytics <hello@ultralytics.com>",
"keywords": "machine-learning, deep-learning, computer-vision, ML, DL, AI, YOLO, YOLOv3, YOLOv5, YOLOv8, HUB, Ultralytics",
"author": null,
"author_email": "Ultralytics <hello@ultralytics.com>",
"download_url": "https://files.pythonhosted.org/packages/12/f4/cef3f7fd9de63e1d6641651d5eb46ed9bcdab42a9ecd52424d0a2e52dabf/hub_sdk-0.0.17.tar.gz",
"platform": null,
"description": "<br>\n<a href=\"https://www.ultralytics.com/\" target=\"_blank\"><img src=\"https://raw.githubusercontent.com/ultralytics/assets/main/logo/Ultralytics_Logotype_Original.svg\" width=\"320\" alt=\"Ultralytics logo\"></a>\n\n# \ud83d\ude80 Ultralytics HUB-SDK\n\n[](https://github.com/ultralytics/hub-sdk/actions/workflows/ci.yml) <a href=\"https://discord.com/invite/ultralytics\"><img alt=\"Discord\" src=\"https://img.shields.io/discord/1089800235347353640?logo=discord&logoColor=white&label=Discord&color=blue\"></a> <a href=\"https://community.ultralytics.com/\"><img alt=\"Ultralytics Forums\" src=\"https://img.shields.io/discourse/users?server=https%3A%2F%2Fcommunity.ultralytics.com&logo=discourse&label=Forums&color=blue\"></a> <a href=\"https://reddit.com/r/ultralytics\"><img alt=\"Ultralytics Reddit\" src=\"https://img.shields.io/reddit/subreddit-subscribers/ultralytics?style=flat&logo=reddit&logoColor=white&label=Reddit&color=blue\"></a>\n\nWelcome to the Ultralytics HUB-SDK documentation! \ud83d\udcd6 Our aim is to guide you through the installation process and help you get started with using HUB-SDK for your machine learning endeavors.\n\n## \ud83d\udee0 Quickstart: Installing HUB-SDK\n\nReady to dive into HUB-SDK? Follow these steps to set it up on your machine.\n\n### Prerequisites\n\nEnsure you have the following requirements met before proceeding:\n\n- **Python:** HUB-SDK requires Python. Download and install Python from [python.org](https://www.python.org/downloads/) if it's not already installed on your system.\n\n- **Git (Optional):** If you're looking to install HUB-SDK via the GitHub repository, you'll need Git. Grab Git from [git-scm.com](https://git-scm.com/downloads) if you don't have it.\n\n### Installation Methods\n\nChoose from the following options to install HUB-SDK:\n\n#### Installing from PyPI\n\n[](https://badge.fury.io/py/hub-sdk) [](https://www.pepy.tech/projects/hub-sdk)\n\nFor the latest stable release of HUB-SDK, use PyPI by running the following command:\n\n```sh\npip install hub-sdk\n```\n\n### \ud83d\ude80 Usage\n\nLet's begin using the HUB-SDK to perform CRUD operations for Models, Datasets, and Projects.\n\n#### 1. Import HUB-SDK\n\nStart by importing the `HUBClient` from the `hub_sdk` module with `from hub_sdk import HUBClient`.\n\n#### 2. Authenticate with Credentials\n\nSet your credentials using one of the following methods:\n\n##### Using API Key\n\n```python\n# Authenticate using an API key\ncredentials = {\"api_key\": \"YOUR_API_KEY\"}\n```\n\nor\n\n##### Using Email and Password\n\n```python\n# Authenticate using your email and password\ncredentials = {\"email\": \"YOUR_EMAIL\", \"password\": \"YOUR_PASSWORD\"}\n```\n\n#### 3. Initialize the HUBClient\n\nWith your credentials ready, initialize the `HUBClient`:\n\n```python\nfrom hub_sdk import HUBClient\n\n# Initialize the client with your credentials\nclient = HUBClient(credentials)\n```\n\n#### Operations\n\nBelow are code snippets demonstrating create, read, update, and delete (CRUD) operations for Projects, Models, and Datasets.\n\n#### Project Operations\n\nManaging projects is simple:\n\n```python\n# Manipulate a project with the given ID\nproject = client.project(\"PROJECT_ID\")\n\n# Create a new project with the specified data\ncreate_project = project.create_project(\"PROJECT_DATA\")\n\n# Update the existing project with new data\nupdate_project = project.update(\"UPDATE_DATA\")\n\n# Delete the project\ndeleted_project = project.delete()\n```\n\n#### Model Operations\n\nHandle models effortlessly:\n\n```python\n# Engage with a model using the given ID\nmodel = client.model(\"MODEL_ID\")\n\n# Create a new model providing the necessary data\ncreate_model = model.create_project(\"MODEL_DATA\")\n\n# Update the model using provided data\nupdate_model = model.update(\"UPDATE_DATA\")\n\n# Remove the model from the system\ndeleted_model = model.delete()\n```\n\n#### Dataset Operations\n\nDatasets operations are straightforward:\n\n```python\n# Interact with a dataset using the specified ID\ndataset = client.dataset(\"DATASET_ID\")\n\n# Establish a new dataset given the data\ncreate_dataset = dataset.create_project(\"DATASET_DATA\")\n\n# Adjust the dataset with updated information\nupdate_dataset = dataset.update(\"UPDATE_DATA\")\n\n# Erase the dataset\ndeleted_dataset = dataset.delete()\n```\n\n## \ud83d\ude80 Ultralytics HUB\n\nExperience seamless AI with [Ultralytics HUB](https://www.ultralytics.com/hub) \u2b50, the all-in-one platform for data visualization, model training, and deployment using YOLO11 \ud83d\ude80. Effortlessly transform images into actionable insights without writing any code. Bring your AI visions to life with our user-friendly [Ultralytics App](https://www.ultralytics.com/app-install) and cutting-edge tools. Start your journey for **Free** today!\n\n<a href=\"https://www.ultralytics.com/hub\" target=\"_blank\">\n<img width=\"100%\" src=\"https://github.com/ultralytics/assets/raw/main/im/ultralytics-hub.png\" alt=\"Ultralytics HUB preview image\"></a>\n\n## \ud83d\udca1 Contribute\n\nWe're thrilled to have you contribute to Ultralytics' open-source projects! Your support and contributions make a world of difference. Get involved by checking out our [Contributing Guide](https://docs.ultralytics.com/help/contributing/), and share your feedback through our [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey). A massive thank you \ud83d\ude4f to everyone who contributes!\n\n<a href=\"https://github.com/ultralytics/yolov5/graphs/contributors\">\n<img width=\"100%\" src=\"https://github.com/ultralytics/assets/raw/main/im/image-contributors.png\" alt=\"Ultralytics open-source contributors\"></a>\n\n## \ud83d\udcc4 License\n\nUltralytics provides two types of licensing options:\n\n- **AGPL-3.0 License**: An [OSI-approved](https://opensource.org/license) open-source license. Ideal for academics, researchers, and enthusiasts, this license promotes sharing knowledge and collaboration. See the [LICENSE](https://github.com/ultralytics/ultralytics/blob/main/LICENSE) file for details.\n\n- **Enterprise License**: Tailored for commercial applications, this license allows for the integration of Ultralytics software into proprietary products and services. If you're considering using our solutions commercially, please get in touch through [Ultralytics Licensing](https://www.ultralytics.com/license).\n\n## \ud83e\udd1d Contact\n\n- Submit Ultralytics bug reports and feature requests via [GitHub Issues](https://github.com/ultralytics/hub-sdk/issues).\n- Join our [Discord](https://discord.com/invite/ultralytics) for assistance, questions, and discussions with the community and team!\n\n<br>\n<div align=\"center\">\n <a href=\"https://github.com/ultralytics\"><img src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-github.png\" width=\"3%\" alt=\"Ultralytics GitHub\"></a>\n <img src=\"https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png\" width=\"3%\" alt=\"space\">\n <a href=\"https://www.linkedin.com/company/ultralytics/\"><img src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-linkedin.png\" width=\"3%\" alt=\"Ultralytics LinkedIn\"></a>\n <img src=\"https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png\" width=\"3%\" alt=\"space\">\n <a href=\"https://twitter.com/ultralytics\"><img src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-twitter.png\" width=\"3%\" alt=\"Ultralytics Twitter\"></a>\n <img src=\"https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png\" width=\"3%\" alt=\"space\">\n <a href=\"https://youtube.com/ultralytics?sub_confirmation=1\"><img src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-youtube.png\" width=\"3%\" alt=\"Ultralytics YouTube\"></a>\n <img src=\"https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png\" width=\"3%\" alt=\"space\">\n <a href=\"https://www.tiktok.com/@ultralytics\"><img src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-tiktok.png\" width=\"3%\" alt=\"Ultralytics TikTok\"></a>\n <img src=\"https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png\" width=\"3%\" alt=\"space\">\n <a href=\"https://ultralytics.com/bilibili\"><img src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-bilibili.png\" width=\"3%\" alt=\"Ultralytics BiliBili\"></a>\n <img src=\"https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png\" width=\"3%\" alt=\"space\">\n <a href=\"https://discord.com/invite/ultralytics\"><img src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-discord.png\" width=\"3%\" alt=\"Ultralytics Discord\"></a>\n</div>\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "Ultralytics HUB Client SDK.",
"version": "0.0.17",
"project_urls": {
"Bug Reports": "https://github.com/ultralytics/hub-sdk/issues",
"Changelog": "https://github.com/ultralytics/hub-sdk/releases",
"Documentation": "https://docs.ultralytics.com",
"Homepage": "https://ultralytics.com",
"Source": "https://github.com/ultralytics/hub-sdk"
},
"split_keywords": [
"machine-learning",
" deep-learning",
" computer-vision",
" ml",
" dl",
" ai",
" yolo",
" yolov3",
" yolov5",
" yolov8",
" hub",
" ultralytics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ba31d92f87e766e60151851000ce85b1e0af35f2c6d9e7508b6026a08f5f7ce7",
"md5": "4304445241a7f3bb3ccb4e373545ad91",
"sha256": "5a43c8bd8d2340aad4253be3c239377f3e46c0cfd803cdf48b03db8000dc6e0c"
},
"downloads": -1,
"filename": "hub_sdk-0.0.17-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4304445241a7f3bb3ccb4e373545ad91",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 42522,
"upload_time": "2024-12-08T17:03:35",
"upload_time_iso_8601": "2024-12-08T17:03:35.999890Z",
"url": "https://files.pythonhosted.org/packages/ba/31/d92f87e766e60151851000ce85b1e0af35f2c6d9e7508b6026a08f5f7ce7/hub_sdk-0.0.17-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "12f4cef3f7fd9de63e1d6641651d5eb46ed9bcdab42a9ecd52424d0a2e52dabf",
"md5": "3bdf8440faed57f7ad1ef57409cdb3af",
"sha256": "de62cb13a012245ca538b84ea9a96d50279156d7fe9436667599a423283b5a1a"
},
"downloads": -1,
"filename": "hub_sdk-0.0.17.tar.gz",
"has_sig": false,
"md5_digest": "3bdf8440faed57f7ad1ef57409cdb3af",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 37664,
"upload_time": "2024-12-08T17:03:37",
"upload_time_iso_8601": "2024-12-08T17:03:37.431549Z",
"url": "https://files.pythonhosted.org/packages/12/f4/cef3f7fd9de63e1d6641651d5eb46ed9bcdab42a9ecd52424d0a2e52dabf/hub_sdk-0.0.17.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-08 17:03:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ultralytics",
"github_project": "hub-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "hub-sdk"
}
JSON
