v2.4.0

Upgrade Steps

• instruction_batch param for create_batch renamed to calibration_batch.

New Features

• self_label_batch param being added for create_batch to create self-label batch on Rapid projects.

v2.3.0

Upgrade Steps

• The param self_serve for create_project is now renamed to rapid

v2.2.0

Upgrade Steps

• ScaleDuplicateTask exception renamed as ScaleDuplicateResource. You should start using the new exception (or replacing old one) after upgrading to the latest version.

New Features

• ScaleClient now supports feeding another base URL for API during initialization
• A new method get_tasks_count() added to return the number of tasks for the given parameters

Other Changes and Notes

• Readme updates
• Release Notes Template is added

v2.1.0

New Features

• Added support for Scale API /files endpoint: https://docs.scale.com/reference#file-overview
  • Two new methods are now available in the SDK: upload_file and import_file
  • Refer to Readme's Files section for more details.

Improvements

• Added instruction_batch parameter as an option while creating new batches.
  • This parameter is used for self-serve projects. https://docs.scale.com/reference#batch-overview

Other Changes and Notes

• Readme updated with Files endpoint examples

v2.0.5

New Features

• Project creation now supports self_serve option.

Improvements

• Extended list of retry codes with 408 and Cloudflare 5xx codes

Other Changes and Notes

• Readme updates

v2.0.4

Improvements

• Extended auto-retry with Cloudflare response codes 5xx
• Improved default exception handling

Other Changes and Notes

• Type hinting for Exception map

v2.0.3

• SDK handles 503 Response code as ScaleServiceUnavailable, with auto-retry
• For unknown error types from API, the default exception ScaleException is extended with the source Response Code
• Readme is updated

v2.0.2

Bugfixing and readme updates.

v2.0.1

• Code samples in Readme updated
• CircleCI configured for automated build, test and publish
• HTTP Retry will be applied for 500 error code as well

v2.0.0

What's New in v2

Please refer to latest README and Migration Guide for detailed documentation.

New Ways to Interact with Scale API:

• Introduced get_tasks() to retrieve tasks easier by handling pagination, tokens, offsets, and timeouts
• create_TaskType_task(...) methods are replaced with create_task(TaskType, ...) by supporting new Task Types like Lidar
• A new method as_dict() introduced to access objects as a dictionary
• Deprecated some methods (fetch_task and list_batches) to avoid naming confusion
• Object models are updated for Task, Project, and Batch

API and Infrastructure Improvements:

• Enabled HTTP retry for certain error codes
• Improved error handling and introduced new Exception types.
• Enabled type hinting across the package

Documentation Updates:

• New Migration Guide for v2
• New Developer Guide for SDK developers
• README is uploaded to PyPI

For Developers:

• New coding standards are applied via Pylint, flake8, and black
• Integrated pre-commit for a better/consistent developer experience
• publish.sh introduced for an automated publish to PyPI
• New pytest test cases are added