Skip to content

v0.1.54 - Update Platform API contract (#78)

Choose a tag to compare

@github-actions github-actions released this 22 Sep 00:40
· 20 commits to main since this release
61fb9c8

🌟 Summary

Expanded Platform image prediction and batch-annotation model support, while making the Python SDK versioning and regeneration process more reliable and consistent. 🚀

📊 Key Changes

  • Added hosted prediction models 🧠
    Image prediction and dataset batch annotation now recognize additional model identifiers, including:

    • florence2
    • owlv2
    • yoloe26x
    • groundingdino
    • Several additional hosted generative and vision models
  • Improved prediction documentation 📚
    The API and generated Python SDK now explain that hosted models:

    • Use model-specific confidence thresholds
    • Return detections without confidence scores
    • May return partial results when generative output is truncated
    • Do not support depth datasets for annotation conversion
  • Regenerated the Python SDK 🐍
    The SDK’s type hints and documentation now expose the expanded model_id choices for both synchronous and asynchronous image prediction and dataset batch-annotation methods.

  • Updated the Platform API contract to 0.1.54 🔄
    The ultralytics-platform package now matches the upstream API contract version exactly.

  • Strengthened CI validation ✅
    CI now verifies that:

    • The API contract uses a valid MAJOR.MINOR.PATCH version
    • The SDK package version matches the API contract
    • No independent SDK version override is configured
    • Generated SDK files remain synchronized with the contract
  • Clarified release and recovery procedures 🛠️
    Documentation now establishes the upstream Platform API contract as the single source of truth for SDK releases. SDK-only or generator changes require a coordinated API contract version bump rather than an independent SDK patch increment.

🎯 Purpose & Impact

  • More annotation options: Users can choose from a broader range of hosted vision models for image prediction and automated dataset labeling. 🎯
  • Better Python developer experience: Updated type hints and documentation make supported model identifiers easier to discover and use.
  • More dependable releases: Enforcing a single API and SDK version prevents mismatches between the deployed Platform API and the published Python package.
  • Safer automation: Deterministic SDK regeneration and stricter CI checks reduce generated-code drift and help ensure releases contain the intended API behavior.
  • Important compatibility note: This release primarily expands Platform API and SDK capabilities; it does not introduce a new core YOLO model architecture. Users should confirm that their selected hosted model is available for their Platform workflow and account.

What's Changed

Full Changelog: v0.1.52...v0.1.54