{"author":null,"author_email":"Ultralytics ","bugtrack_url":null,"classifiers":["Development Status :: 4 - Beta","Intended Audience :: Developers","Intended Audience :: Education","Intended Audience :: Science/Research","License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)","Operating System :: MacOS","Operating System :: Microsoft :: Windows","Operating System :: POSIX :: Linux","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Topic :: Scientific/Engineering","Topic :: Scientific/Engineering :: Artificial Intelligence","Topic :: Scientific/Engineering :: Image Recognition","Topic :: Software Development"],"description":"
\n $\"Ultralytics$ \n\n# 🚀 Ultralytics HUB-SDK\n\n[![HUB-SDK CI](https://github.com/ultralytics/hub-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/ultralytics/hub-sdk/actions/workflows/ci.yml) $\"Discord\"$ $\"Ultralytics$ $\"Ultralytics$ \n\nWelcome 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.\n\n## 🛠 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[![PyPI version](https://badge.fury.io/py/hub-sdk.svg)](https://badge.fury.io/py/hub-sdk) [![Downloads](https://static.pepy.tech/badge/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### 🚀 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## 🚀 Ultralytics HUB\n\nExperience 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!\n\n\n $\"Ultralytics$ \n\n## 💡 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 🙏 to everyone who contributes!\n\n\n $\"Ultralytics$ \n\n## 📄 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## 🤝 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
\n

\n $\"Ultralytics$ \n $\"space\"$ \n $\"Ultralytics$ \n $\"space\"$ \n $\"Ultralytics$ \n $\"space\"$ \n $\"Ultralytics$ \n $\"space\"$ \n $\"Ultralytics$ \n $\"space\"$ \n $\"Ultralytics$ \n $\"space\"$ \n $\"Ultralytics$ \n

\n","description_content_type":"text/markdown","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":null,"keywords":"machine-learning, deep-learning, computer-vision, ML, DL, AI, YOLO, YOLOv3, YOLOv5, YOLOv8, HUB, Ultralytics","license":"AGPL-3.0","license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":"Ultralytics ","name":"hub-sdk","package_url":"https://pypi.org/project/hub-sdk/","platform":null,"project_url":"https://pypi.org/project/hub-sdk/","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"},"provides_extra":["dev"],"release_url":"https://pypi.org/project/hub-sdk/0.0.20/","requires_dist":["requests","pytest; extra == \"dev\"","pytest-cov; extra == \"dev\"","coverage[toml]; extra == \"dev\"","mkdocs>=1.6.0; extra == \"dev\"","mkdocs-material; extra == \"dev\"","mkdocstrings[python]; extra == \"dev\"","mkdocs-redirects; extra == \"dev\"","mkdocs-ultralytics-plugin>=0.1.16; extra == \"dev\""],"requires_python":">=3.8","summary":"Ultralytics HUB Client SDK.","version":"0.0.20","yanked":false,"yanked_reason":null}

Dependency	Optional
requests	false
coverage	true
mkdocs	true
mkdocs-material	true
mkdocs-redirects	true
mkdocs-ultralytics-plugin	true
mkdocstrings	true
pytest	true
pytest-cov	true

Package search

hub-sdk

project_urls

Dependencies

All package metadata

Releases