Package: hub-sdk
🚀 Ultralytics HUB-SDKWelcome 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-SDKReady to dive into HUB-SDK? Follow these steps to set it up on your machine.PrerequisitesEnsure you have the following requirements met before proceeding:Python:HUB-SDK requires Python. Download and install Python frompython.orgif 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 fromgit-scm.comif you don't have it.Installation MethodsChoose from the following options to install HUB-SDK:Installing from PyPIFor the latest stable release of HUB-SDK, use PyPI by running the following command:pipinstallhub-sdk🚀 UsageLet's begin using the HUB-SDK to perform CRUD operations for Models, Datasets, and Projects.1. Import HUB-SDKStart by importing theHUBClientfrom thehub_sdkmodule:fromhub_sdkimportHUBClient2. Authenticate with CredentialsSet your credentials using one of the following methods:Using API Key# Authenticate using an API keycredentials={"api_key":"YOUR_API_KEY"}orUsing Email and Password# Authenticate using your email and passwordcredentials={"email":"YOUR_EMAIL","password":"YOUR_PASSWORD"}3. Initialize the HUBClientWith your credentials ready, initialize theHUBClient:# Initialize the client with your credentialsclient=HUBClient(credentials)CRUD OperationsBelow are code snippets demonstrating CRUD operations for Projects, Models, and Datasets.Project OperationsManaging projects is simple:# Manipulate a project with the given IDproject=client.project("PROJECT_ID")# Create a new project with the specified datacreate_project=project.create_project("PROJECT_DATA")# Update the existing project with new dataupdate_project=project.update("UPDATE_DATA")# Delete the projectdeleted_project=project.delete()Model OperationsHandle models effortlessly:# Engage with a model using the given IDmodel=client.model("MODEL_ID")# Create a new model providing the necessary datacreate_model=model.create_project("MODEL_DATA")# Update the model using provided dataupdate_model=model.update("UPDATE_DATA")# Remove the model from the systemdeleted_model=model.delete()Dataset OperationsDatasets operations are straightforward:# Interact with a dataset using the specified IDdataset=client.dataset("DATASET_ID")# Establish a new dataset given the datacreate_dataset=dataset.create_project("DATASET_DATA")# Adjust the dataset with updated informationupdate_dataset=dataset.update("UPDATE_DATA")# Erase the datasetdeleted_dataset=dataset.delete()💡 ContributeWe'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 ourContributing Guide, and share your feedback through ourSurvey. A massive thank you 🙏 to everyone who contributes!📄 LicenseUltralytics provides two types of licensing options:AGPL-3.0 License: AnOSI-approvedopen-source license. Ideal for academics, researchers, and enthusiasts, this license promotes sharing knowledge and collaboration. See theLICENSEfile 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 throughUltralytics Licensing.🤝 ContactSubmit Ultralytics bug reports and feature requests viaGitHub Issues.Join ourDiscordfor assistance, questions, and discussions with the community and team!