Merge pull request #252 from Labelbox/ms/prediction-import-update-2

split annotation import

Author: msokoloff1

.github/workflows/publish.yaml

@@ -28,11 +28,6 @@ jobs:
       run: |
         python setup.py sdist bdist_wheel
 
-    - name: Update help docs
-      run: |
-        python setup.py install
-        python ./tools/api_reference_generator.py ${{ secrets.HELPDOCS_API_KEY }}
-
     - name: Publish
       env:
         TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}

CHANGELOG.md

@@ -1,12 +1,127 @@
 # Changelog
 
-# Next Release
+# Version 3.0.1 (2021-08-12)
+## Fix
+* Issue with inferring text type from export
+
+# Version 3.0.0 (2021-08-12)
+## Added
+* Annotation types
+    - A set of python objects for working with labelbox data
+    - Creates a standard interface for both exports and imports
+    - See example notebooks on how to use under examples/annotation_types
+    - Note that these types are not yet supported for tiled imagery
+* MEA Support
+    - Beta MEA users can now just use the latest SDK release
+* Metadata support
+    - New metadata features are now fully supported by the SDK
+* Easier export
+    - `project.export_labels()` accepts a boolean indicating whether or not to download the result
+    - Create annotation objects directly from exports with `project.label_generator()` or `project.video_label_generator()`
+    - `project.video_label_generator()` asynchronously fetches video annotations
+* Retry logic on data uploads
+    - Bulk creation of data rows will be more reliable
+* Datasets
+    - Determine the number of data rows just by calling `dataset.row_count`.
+    - Updated threading logic in create_data_rows() to make it compatible with aws lambdas
+* Ontology
+    - `OntologyBuilder`, `Classification`, `Option`, and `Tool` can now be imported from `labelbox` instead of `labelbox.schema.ontology`
+
+## Removed
+* Deprecated:
+    - `project.reviews()`
+    - `project.create_prediction()`
+    - `project.create_prediction_model()`
+    - `project.create_label()`
+    - `Project.predictions()`
+    - `Project.active_prediction_model`
+    - `data_row.predictions`
+    - `PredictionModel`
+    - `Prediction`
+* Replaced:
+    - `data_row.metadata()` use `data_row.attachments()` instead
+    - `data_row.create_metadata()` use `data_row.create_attachments()` instead
+    - `AssetMetadata` use `AssetAttachment` instead
+
+## Fixes
+* Support derived classes of ontology objects when using `from_dict`
+* Notebooks:
+    - Video export bug where the code would fail if the exported projects had tools other than bounding boxes
+    - MAL demos were broken due to an image download failing.
+
+## Misc
+* Data processing dependencies are not installed by default to for users that only want client functionality.
+* To install all dependencies required for the data modules (annotation types and mea metric calculation) use `pip install labelbox[data]`
+* Decrease wait time between updates for `BulkImportRequest.wait_until_done()`.
+* Organization is no longer used to create the LFO in `Project.setup()`
+
+
+# Version 3.0.0-rc3 (2021-08-11)
+## Updates
+* Geometry.raster now has a consistent interface and improved functionality
+* renamed schema_id to feature_schema_id in the `FeatureSchema` class
+* `Mask` objects now use `MaskData` to represent segmentation masks instead of `ImageData`
+
+# Version 3.0.0-rc2 (2021-08-09)
+## Updates
+* Rename `data` property of TextData, ImageData, and VideoData types to `value`.
+* Decrease wait time between updates for `BulkImportRequest.wait_until_done()`
+* Organization is no longer used to create the LFO in `Project.setup()`
+
+
+# Version 3.0.0-rc1 (2021-08-05)
+## Added
+* Model diagnostics notebooks
+* Minor annotation type improvements
+
+# Version 3.0.0-rc0 (2021-08-04)
+## Added
+* Annotation types
+    - A set of python objects for working with labelbox data
+    - Creates a standard interface for both exports and imports
+    - See example notebooks on how to use under examples/annotation_types
+    - Note that these types are not yet supported for tiled imagery
+* MEA Support
+    - Beta MEA users can now just use the latest SDK release
+* Metadata support
+    - New metadata features are now fully supported by the SDK
+* Easier export
+    - `project.export_labels()` accepts a boolean indicating whether or not to download the result
+    - Create annotation objects directly from exports with `project.label_generator()` or `project.video_label_generator()`
+    - `project.video_label_generator()` asynchronously fetches video annotations
+* Retry logic on data uploads
+    - Bulk creation of data rows will be more reliable
+* Datasets
+    - Determine the number of data rows just by calling `dataset.row_count`.
+    - Updated threading logic in create_data_rows() to make it compatible with aws lambdas
+* Ontology
+    - `OntologyBuilder`, `Classification`, `Option`, and `Tool` can now be imported from `labelbox` instead of `labelbox.schema.ontology`
+
 ## Removed
-* Deprecated functions
-    - project.reviews()
-    - project.create_prediction()
-    - project.create_prediction_model()
-    - project.create_label()
+* Deprecated:
+    - `project.reviews()`
+    - `project.create_prediction()`
+    - `project.create_prediction_model()`
+    - `project.create_label()`
+    - `Project.predictions()`
+    - `Project.active_prediction_model`
+    - `data_row.predictions`
+    - `PredictionModel`
+    - `Prediction`
+* Replaced:
+    - `data_row.metadata()` use `data_row.attachments()` instead
+    - `data_row.create_metadata()` use `data_row.create_attachments()` instead
+    - `AssetMetadata` use `AssetAttachment` instead
+
+## Fixes
+* Support derived classes of ontology objects when using `from_dict`
+* Notebooks:
+    - Video export bug where the code would fail if the exported projects had tools other than bounding boxes
+    - MAL demos were broken due to an image download failing.
+
+## Misc
+* Data processing dependencies are not installed by default to for users that only want client functionality.
+* To install all dependencies required for the data modules (annotation types and mea metric calculation) use `pip install labelbox[data]`
 
 # Version 2.7b1+mea (2021-06-27)
 ## Fix

CONTRIB.md

@@ -27,31 +27,31 @@ following packages/modules:
 
 ## Testing
 
-Currently the SDK functionality is tested using integration tests. These tests
+Currently, the SDK functionality is tested using integration tests. These tests
 communicate with a Labelbox server (by default the staging server) and are in
-that sense not self-contained. Besides that they are organized like unit test
+that sense not self-contained. Besides, that they are organized like unit test
 and are based on the `pytest` library.
 
 To execute tests you will need to provide an API key for the server you're using
 for testing (staging by default) in the `LABELBOX_TEST_API_KEY` environment
-variable. For more info see [Labelbox API key
-docs](https://labelbox.helpdocs.io/docs/api/getting-started).
+variable. For more info see [Labelbox API key docs](https://labelbox.helpdocs.io/docs/api/getting-started).
+
+To pass tests, code must be formatted using the following command:
+
+```shell
+yapf labelbox -i --verbose --recursive --parallel --style "google"
+```
 
 ## Release Steps
 
 Each release should follow the following steps:
 
 1. Update the Python SDK package version in `REPO_ROOT/setup.py`
-2. Make sure the `CHANGELOG.md` contains appropriate info 
+2. Make sure the `CHANGELOG.md` contains appropriate info
 3. Commit these changes and tag the commit in Git as `vX.Y`
 4. Merge `develop` to `master` (fast-forward only).
 5. Create a GitHub release.
 6. This will kick off a Github Actions workflow that will:
-  - Build the library in the [standard
-  way](https://packaging.python.org/tutorials/packaging-projects/#generating-distribution-archives)
-  - Upload the distribution archives in the [standard
-  way](https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives)
+  - Build the library in the [standard way](https://packaging.python.org/tutorials/packaging-projects/#generating-distribution-archives)
+  - Upload the distribution archives in the [standard way](https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives)
   with credentials for the `labelbox` PyPI user.
-  - Run the `REPO_ROOT/tools/api_reference_generator.py` script to update
-  [HelpDocs documentation](https://labelbox.helpdocs.io/docs/). You will need
-  to provide a HelpDocs API key for.

README.md

@@ -44,6 +44,10 @@ Install dependencies
 ```
 pip3 install -r requirements.txt
 ```
+To install dependencies required for data processing modules use:
+```
+pip install labelbox[data]
+```
 
 ## Documentation
 

docs/source/conf.py

@@ -21,7 +21,7 @@
 copyright = '2021, Labelbox'
 author = 'Labelbox'
 
-release = '2.6.0'
+release = '3.0.0-rc0'
 
 # -- General configuration ---------------------------------------------------
 

docs/source/index.rst

@@ -21,12 +21,6 @@ AssetAttachment
    :members:
    :show-inheritance:
 
-AssetMetadata
---------------------------------------
-
-.. automodule:: labelbox.schema.asset_metadata
-   :members:
-   :show-inheritance:
 
 Benchmark
 --------------------------------