Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Readme
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.
Ready to dive into HUB-SDK? Follow these steps to set it up on your machine.
Ensure you have the following requirements met before proceeding:
Python: HUB-SDK requires Python. Download and install Python from python.org 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 if you don't have it.
Choose from the following options to install HUB-SDK:
For the latest stable release of HUB-SDK, use PyPI by running the following command:
pip install hub-sdk
Let's begin using the HUB-SDK to perform CRUD operations for Models, Datasets, and Projects.
Start by importing the HUBClient
from the hub_sdk
module:
from hub_sdk import HUBClient
Set your credentials using one of the following methods:
# Authenticate using an API key
credentials = {"api_key": "YOUR_API_KEY"}
or
# Authenticate using your email and password
credentials = {"email": "YOUR_EMAIL", "password": "YOUR_PASSWORD"}
With your credentials ready, initialize the HUBClient
:
# Initialize the client with your credentials
client = HUBClient(credentials)
Below are code snippets demonstrating create, read, update, and delete (CRUD) operations for Projects, Models, and Datasets.
Managing projects is simple:
# 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()
Handle models effortlessly:
# 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()
Datasets operations are straightforward:
# 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()
Experience seamless AI with Ultralytics HUB ⭐, the all-in-one solution for data visualization, YOLOv5 and YOLOv8 🚀 model training and deployment, without any coding. Transform images into actionable insights and bring your AI visions to life with ease using our cutting-edge platform and user-friendly Ultralytics App. Start your journey for Free now!
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, and share your feedback through our Survey. A massive thank you 🙏 to everyone who contributes!
Ultralytics provides two types of licensing options:
AGPL-3.0 License: An OSI-approved open-source license. Ideal for academics, researchers, and enthusiasts, this license promotes sharing knowledge and collaboration. See the 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.
FAQs
Ultralytics HUB Client SDK.
We found that hub-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.