Hub-sdk

🌟 Summary
The `threaded` decorator has been upgraded to offer more flexibility, allowing users to choose between threaded or synchronous function execution.

📊 Key Changes
- Enhanced the `threaded` decorator to include a `threaded=False` option, enabling synchronous function execution when desired.
- Improved documentation and examples to make the decorator's functionality clearer and easier to use.
- Updated the SDK version from `0.0.19` to `0.0.20`.

🎯 Purpose & Impact
- **Increased Flexibility**: Developers now have the option to run functions either in the background (threaded) or synchronously, making the SDK more versatile for different workflows.
- **Better Usability**: Enhanced documentation ensures users can quickly understand and implement the updated `threaded` decorator.
- **Version Alignment**: The version bump reflects the new features and improvements, signaling progress and encouraging users to update.

🚀 This update empowers developers with greater control over function execution, improving adaptability and ease of use!

What's Changed
* Update `threaded()` to conform to `ultralytics` implementation by glenn-jocher in https://github.com/ultralytics/hub-sdk/pull/250


**Full Changelog**: https://github.com/ultralytics/hub-sdk/compare/v0.0.19...v0.0.20

🌟 Summary
The `v0.0.19` release of the Ultralytics HUB SDK introduces a version bump to ensure compatibility, enhanced functionality, and a foundation for future improvements. 🚀

📊 Key Changes
- **SDK Version Update**: Upgraded from `0.0.18` to `0.0.19` for improved compatibility and functionality.
- **License Standardization**: Updated license headers across all files (Python, YAML, TOML, etc.) to ensure consistency and clarity.
- **Documentation Enhancements**: Improved SDK documentation with refined content, better type annotations, and updated examples.
- **Plugin Update**: Upgraded `mkdocs-ultralytics-plugin` to version `0.1.16` for enhanced documentation features.
- **CI Workflow Improvements**: Enhanced link-checking workflows to provide detailed summaries in GitHub Actions.

🎯 Purpose & Impact
- 🛠 **Improved Compatibility**: The version bump ensures the SDK remains compatible with the latest tools and services in the Ultralytics ecosystem.
- 📚 **Clearer Licensing**: Standardized license headers provide legal clarity and reinforce Ultralytics branding.
- ✍️ **Better Documentation**: Enhanced documentation improves usability for developers, making it easier to understand and implement SDK features.
- 🚀 **Streamlined Workflows**: The updated plugin and CI improvements simplify development workflows, reducing manual effort and improving efficiency.
- 🔄 **Future-Ready**: These updates lay the groundwork for upcoming features and bug fixes, ensuring a smoother user experience.

Enjoy the improved SDK experience and seamless integration with Ultralytics HUB! 🌟

What's Changed
* Standardize license headers in Python files by pderrenger in https://github.com/ultralytics/hub-sdk/pull/243
* Standardize license headers in TOML/YAML files by pderrenger in https://github.com/ultralytics/hub-sdk/pull/244
* Update pyproject.toml by glenn-jocher in https://github.com/ultralytics/hub-sdk/pull/246
* mkdocs-ultralytics-plugin>=0.1.16 by glenn-jocher in https://github.com/ultralytics/hub-sdk/pull/247
* Update links.yml by glenn-jocher in https://github.com/ultralytics/hub-sdk/pull/248
* Improve documentation by glenn-jocher in https://github.com/ultralytics/hub-sdk/pull/249
* Update __init__.py by glenn-jocher in https://github.com/ultralytics/hub-sdk/pull/245


**Full Changelog**: https://github.com/ultralytics/hub-sdk/compare/v0.0.18...v0.0.19

🌟 Summary
The v0.0.18 release of the Ultralytics HUB-SDK focuses on improving internal processes and code standardization, laying the groundwork for better efficiency and compliance without introducing direct user-facing features. 🎉

---

📊 Key Changes
- **Version Update**: `hub-sdk` updated to version 0.0.18.
- **Enhanced License Headers**: Unified and updated to include a clear license link in all source and test files.
- **Exponential Backoff for Model Exports**: Implemented smarter retry intervals for checking model export status.
- **New CI Workflow**: Introduced advanced CI processes with testing and documentation automation.
- **Automation Improvements**: Streamlined token handling, Lychee installation, and dependency updates for GitHub workflows.
- **Code Refactoring**: Improved readability, performance, and removed duplicated or outdated code.
- **Formatting Update**: Reformatted code using Ruff 0.9.0 to adhere to the latest style standards.

---

🎯 Purpose & Impact
- **Smooth Versioning**: The minor version update prepares users for upcoming SDK enhancements. 🚀
- **Increased Compliance**: The new license headers make legal terms transparent and accessible. 💼
- **Improved Efficiency**: Smarter retry logic reduces server load and ensures model exports are handled gracefully. 🔄
- **Reliable Testing & Automation**: Enhanced CI enables consistent quality checks for all updates, reducing manual intervention. ✅
- **Streamlined Developer Experience**: Workflow and code improvements speed up development and maintenance, enhancing productivity. ⚡
- **Cleaner Codebase**: Refactoring ensures better readability and system performance over the long term. 🧹

This release ensures a more robust base for the HUB-SDK while providing developers with smoother workflows and clearer compliance standards. 🌟

What's Changed
* Update format.yml by glenn-jocher in https://github.com/ultralytics/hub-sdk/pull/234
* Bump astral-sh/setup-uv from 4 to 5 in /.github/workflows by dependabot[bot] in https://github.com/ultralytics/hub-sdk/pull/233
* Update links.yml by glenn-jocher in https://github.com/ultralytics/hub-sdk/pull/235
* Delete .github/workflows/ci.yml by glenn-jocher in https://github.com/ultralytics/hub-sdk/pull/236
* Create ci.yml by glenn-jocher in https://github.com/ultralytics/hub-sdk/pull/237
* Add Exponential Backoff to Model Export Status Check by yogendrasinghx in https://github.com/ultralytics/hub-sdk/pull/238
* Ultralytics Refactor https://ultralytics.com/actions by glenn-jocher in https://github.com/ultralytics/hub-sdk/pull/239
* Apply `ruff==0.9.0` formatting by glenn-jocher in https://github.com/ultralytics/hub-sdk/pull/240
* Standardize license headers in Python files by glenn-jocher in https://github.com/ultralytics/hub-sdk/pull/241
* Improved Python file headers by glenn-jocher in https://github.com/ultralytics/hub-sdk/pull/242


**Full Changelog**: https://github.com/ultralytics/hub-sdk/compare/v0.0.17...v0.0.18

🌟 Summary
The `v0.0.17` release of the **Ultralytics HUB SDK** introduces several significant updates focused on improving workflow efficiency, modularity, and security, alongside minor adjustments for branding consistency and versioning. 🚀✨

---

📊 Key Changes
- **Enhanced CI/CD Workflow (PR 231 & 229):**
- Introduced modular stages (`check`, `build`, `publish`, `notify`) for better process clarity. 🛠️
- Improved version-checking logic for smarter package building and publishing. 🔍
- Added Slack notifications for release status updates. 📣
- Implemented granular permissions for better security. 🔒

- **Security Improvements & Workflow Adjustments (PR 230 & 227):**
- Changed GitHub CI workflow trigger to `pull_request` for better safety against untrusted forked code. 🛡️
- Removed the `CodeQL` workflow file, simplifying maintenance. 🗑️

- **Branding and Documentation Updates (PR 228):**
- Updated assets (favicon and logo) to use externally hosted versions, ensuring lightweight repo size and unified branding. ✨

- **Version Bump to `0.0.17` (PR 232):**
- Updated the SDK version, incorporating all the latest fixes and improvements. 🔧

---

🎯 Purpose & Impact
- **🚀 Improved Developer Experience:**
- Modularized workflows with clearer steps reduce maintenance complexity and error rates, making debugging and scaling easier.
- Notifications keep teams up-to-date on release progress.

- **🔒 Enhanced Security:**
- Adjustments to GitHub workflows and permissions prioritize safety and align with best practices, minimizing risks in CI/CD pipelines.

- **✨ Streamlined Asset Management:**
- External hosting of logo and favicon reduces repository clutter and ensures consistent branding across all documentation.

- **📦 Latest Features with `0.0.17`:**
- Version bump ensures users access the newest updates, bug fixes, and improvements for a more reliable SDK experience.

This release underscores Ultralytics’ commitment to security, quality, and developer-focused enhancements, paving the way for a smoother and safer development lifecycle. 🌟

What's Changed
* Ultralytics Refactor https://ultralytics.com/actions by pderrenger in https://github.com/ultralytics/hub-sdk/pull/226
* Delete .github/workflows/codeql.yaml by glenn-jocher in https://github.com/ultralytics/hub-sdk/pull/227
* Favicon updates by glenn-jocher in https://github.com/ultralytics/hub-sdk/pull/228
* Update publish.yml by glenn-jocher in https://github.com/ultralytics/hub-sdk/pull/229
* Update ci.yml by glenn-jocher in https://github.com/ultralytics/hub-sdk/pull/230
* Split PyPI publish jobs for improved security by glenn-jocher in https://github.com/ultralytics/hub-sdk/pull/231
* `hub-sdk 0.0.17` Security improvements by glenn-jocher in https://github.com/ultralytics/hub-sdk/pull/232


**Full Changelog**: https://github.com/ultralytics/hub-sdk/compare/v0.0.16...v0.0.17

🌟 Summary
The v0.0.16 release focuses on enhancing the GitHub Actions workflow notifications and improving the overall code efficiency and reliability.

📊 Key Changes
- **Enhanced Notifications**: The Slack notification format was updated to include the pull request title in alerts, providing more context.
- **Slack API Update**: Updated `slackapi/slack-github-action` to version 2.0.0 for better error handling and notification capabilities.
- **Refactored Workflows**: Improved the CI/CD workflow by optimizing retry logic with a new custom action.
- **Code Optimization**: Various code improvements for better performance and readability.

🎯 Purpose & Impact
- **Improved Clarity in Alerts**: Including the PR title in alerts makes it easier for team members to quickly identify issues and review relevant pull requests. 🛠️
- **Better Communication**: Enhanced notifications improve team awareness of workflow events and outcomes. 📣
- **Enhanced Workflow Efficiency**: Code optimizations and using the updated Slack API provide smoother, more reliable operations, reducing potential errors and downtime. 🔄
- **Version Update**: Incrementing the version ensures users benefit from the latest fixes and improvements, maintaining a stable and up-to-date SDK experience. 🚀

What's Changed
* Fix PyPI downloads links by pderrenger in https://github.com/ultralytics/hub-sdk/pull/220
* Use new Ultralytics Retry action by pderrenger in https://github.com/ultralytics/hub-sdk/pull/221
* Use new Ultralytics Retry action by pderrenger in https://github.com/ultralytics/hub-sdk/pull/222
* Bump slackapi/slack-github-action from 1.27.0 to 2.0.0 in /.github/workflows by dependabot[bot] in https://github.com/ultralytics/hub-sdk/pull/223
* Update to Slack API v2 by glenn-jocher in https://github.com/ultralytics/hub-sdk/pull/224
* Fix publish.yml Slack step by glenn-jocher in https://github.com/ultralytics/hub-sdk/pull/225


**Full Changelog**: https://github.com/ultralytics/hub-sdk/compare/v0.0.15...v0.0.16

🌟 Summary
The 'v0.0.15' release updates the publishing workflow and marks a new version for the SDK, focusing on improving deployment processes.

📊 Key Changes
- **Updated Publishing Workflow**: The GitHub Actions `publish.yml` workflow now includes a new environment setting for deployment tracking.
- **Version Bump**: Updated the SDK version from 0.0.14 to 0.0.15, reflecting the recent improvements and updates.

🎯 Purpose & Impact
- **Improved Deployment Tracking**: By incorporating the environment setting into the workflow, this update enables enhanced tracking of deployments using GitHub's native features, facilitating smoother and more efficient release management. 🚀
- **Signal of Incremental Improvements**: The version bump indicates that users can expect improvements or minor fixes, ensuring they are using the most up-to-date and stable version of the SDK. 📈

What's Changed
* Update environment in publish.yml by glenn-jocher in https://github.com/ultralytics/hub-sdk/pull/219


**Full Changelog**: https://github.com/ultralytics/hub-sdk/compare/v0.0.14...v0.0.15