v1.4.0

New Features:

• Make PagingList mutable, and follow MutableSequence protocol (#462, #472, #475)

• Support reading remote data lazily in Dataset and Segment:

  • Lazy evaluation in Segment (#476, #484)
  • Lazy evaluation in Dataset (#477, #482, #483, #492, #496, #497, #500, #545)

• Support getting segment by name in DatasetBase.__getitem__ (#498)

  • Use segment = dataset["test"] to get segment by name instead of segment = dataset.get_segment_by_name("test").
  • Use segment_names = dataset.keys() to get all segment names in a dataset.

• Add the following methods to convert between category and index for writing training code easier (#468)

  • CategoriesMixin.get_category_to_index
  • CategoriesMixin.get_index_to_category

• Add the following exceptions as subclasses of ResponseError (#437, #458)

  • AccessDeniedError
  • InvalidParamsError
  • NameConflictError
  • RequestParamsMissingError
  • ResourceNotExistError
  • ResponseSystemError
  • UnauthorizedError

• Support skip_uploaded_files flag in GAS.upload_dataset for fusion dataset (#494)

• Add open dataset loader COVID-chestxray and nuScenes (#459, #481)

Improvements:

• Refactor CLI related code to a new module (#479)
• Stop checking the commit_id in DatasetClientBase.__init__ to avoid sending redundant request (#485)
• Fix the possibly unbound variable warning in CompCars (#490)

Documentation:

• Add Update Dataset, Update Label and Update Data chapter (#465, #457, #495)
• Add docs for specific response exceptions (#478)
• Add continuity and tracking in glossary (#493)
• Update docs for reading segments from lazy evaluation Dataset rather than DatasetClient (#486)
• Refine the docs (#448, #451, #426)
• Refine the example in docs (#440, #444, #430, #441, #443, #450, #453)

Deprecations:

• Deprecate DatasetBase.get_segment_by_name (#498)

v1.3.1

Interface Adjustment:

• Rename the following exceptions (#491, #505):
  • TensorBayClientException -> ClientError
  • TensorBayOpendatasetException -> OpenDatasetError

v1.3.0

New Features:

• Implement PagingList to lazy access elements from paging requests, which follows Sequence protocol (#369, #386)

• Use PagingList as the return value instead of iterator for the folloing methods:

  • GAS.list_dataaset_names (#387)
  • DatasetClientBase.list_drafts (#394)
  • DatasetClientBase.list_commits (#395)
  • DatasetClientBase.list_tags (#397)
  • DatasetClientBase.list_branches (#398)
  • DatasetClientBase.list_segment_names (#399)
  • SegmentClient.list_data_paths (#400)
  • SegmentClient.list_data (#402)
  • FusionSegmentClient.list_frames (#403)

• Support creating dataset with auth cloud storage:

  • Add GAS.get_auth_storage_config and GAS.list_auth_storage_configs (#405, #466)
  • Add GAS.create_auth_dataset (#406, #461)

• Add client.config to adjust the request configuration (#456)

  • Support adjusting the config of the request retry strategy: config.timeout, config.max_retry etc.
  • Support uploading/reading data from cloud server internal endpoint (#407)

• Build TensorBay exception system:

  • Add TensorBayException as TensorBay base exception (#380)
  • Add NoFileError and FileStructureError for opendataset module (#385)
  • Add CommitStatusError, ResponseError, DatasetTypeError and FrameError for client module (#391, #431)
  • Add TBRNError for CLI (#416)

• Add bin_point_cloud_fields to dataset Notes to support .bin format point cloud with different fields (#396, #446)

• Display the upload progress by process bar in GAS.upload_dataset and (Fusion)DatasetClient.upload_segment (#480)

• Add open dataset loader opendataset.HalpeFullBody and opendataset.BioIDFace (#364, #452, #372)

Improvements:

• Update open dataset name according to TensorBay latest naming rule (#390, #417, #445)
• Display commit_id in Commit.__repr__ (#415)
• Refine the error message of unexpected status code (#438)
• Delete duplicated loads lexicon code on SentenceSubcatalog (#464)

Documentation:

• Add docs for "Cloud Storage" (#421)
• Add docs for "Request Configuration" (#463, #474)
• Add docs for "Use Internal Endpoint" (#471)
• Add docs for TensorBay exception system (#418, #423)
• Add docs for bin_point_cloud_fields (#419)
• Add tag to glossary docs (#432)
• Refine the docstring and docs (#367, #378, #373, #379, #392, #375, #411, #425, #408, #404, #422, #433, #435, #420)
• Fix typos in docstring and docs(#366, #371, #370, #376, #393, #424, #439, #442, #473)

Deprecations:

• Deprecate the start and stop arguments for methods using PagingList as a return value (#412)
• Deprecate the following legacy exceptions in client module (#388):
  • GASDataTypeError
  • GASLabelsetError
  • GASLabelsetTypeError
  • GASFrameError
  • GASResponseError

v1.2.2

Bug Fixes:

• Fix UnboundLocalError when calling DatasetClientBase.create_tag with revision (#449)
• Fix KeyError when getting a FusionSegment instance (#454, Fix #455)

v1.2.1

Interface Adjustment:

• Rename the argument commit in DatasetClientBase.create_tag to revision (#434)

v1.2.0

New Features:

• Add basic methods for dataset Version Control (#306, #307, #308, #294, #350, #414)

  • Add DatasetClientBase.create_tag (#284)
  • Add DatasetClientBase.list_tags (#287)
  • Add DatasetClientBase.get_tag (#287)
  • Add DatasetClientBase.delete_tag (#289)
  • Add DatasetClientBase.list_branches (#290)
  • Add DatasetClientBase.list_commits (#316)
  • Add DatasetClientBase.get_draft (#318, #337)

• Support dataset with continuous data (#401)

  • Add Notes to store dataset basic information (#293)
  • Add DatasetClientBase.update_notes (#349)
  • Add DatasetClientBase.get_notes (#351)

• Support "Fusion Dataset" (#267, #314, #320, #330, #331, #332, #339)

• Make request session safe in multiprocesses environment (#382)

• Add SDK version info to "Event Tracking" and support "Event Tracking" for CLI (#326, #363)

• Add loader for CADC opendataset (#278, #335)

• Add method create_segment() for dataset client (#291)

• Add __eq__ for Label (#265)

Improvements:

• Modify Tensorbay gateway to "gatewayv2" (#347, #436)
• Refine the NotImplemented logic in binary operators (#271)
• Check whether the url starts with "https://" in Client (#321)
• Implement decorator Deprecated for deprecated functions (#336)

Packaging:

• Add minimum versions for dependancies (#427)

Documentation:

• Add docs for dataset Version Control (#355, #360, #358)
• Add docs for "Fusion Dataset" (#340, #338)
• Add docs for dataset with continuous data and Notes (#313, #345, #346)
• Update urls in docs (#327, #341, #348)
• Refine the docstring and docs (#286, #317, #325, #324, #343, #342)
• Fix typos in docs (#298, #302, #300, #305, #310, #323, #361)
• Add examples to docstring (#219, #220, #217, #218, #229, #297, #301, #303, #304, #296, #292, #232, #209, #236, #295, #315, #233, #221)

Deprecations:

• Deprecate DatasetClientBase.list_draft_titles_and_numbers, use DatasetClientBase.list_draft instead (#337)

v1.1.2

New Features

• Support uploading data to Azure (#280)

Fix Bugs

• Correct dataset names in data loaders according to Graviti Open Dataset (#279)

Documentation

• Fix typos in docs (#274, #276, #273)
• Remove the url related content in the doc of CLI (#275)
• Refine the content of docs and docstring (#277, #261, #281)

v1.1.1

Documentation

• Update the urls in docs and "README.md" (#266, #268)
• Fix typos in docs (#269, #270, #272)

v1.1.0

The first release of TensorBay SDK.