Merge pull request #3234 from voxel51/release-notes

Release notes

docs/source/_includes/substitutions.rst

@@ -16,6 +16,8 @@
 .. |ToClips| replace:: :class:`ToClips <fiftyone.core.stages.ToClips>`
 .. |SortBySimilarity| replace:: :class:`SortBySimilarity <fiftyone.core.stages.SortBySimilarity>`
 
+.. |Document| replace:: :class:`Document <fiftyone.core.document.Document>`
+
 .. |Sample| replace:: :class:`Sample <fiftyone.core.sample.Sample>`
 .. |SampleView| replace:: :class:`SampleView <fiftyone.core.sample.SampleView>`
 

docs/source/release-notes.rst

@@ -3,6 +3,114 @@ FiftyOne Release Notes
 
 .. default-role:: code
 
+.. _release-notes-teams-v1.3.1:
+
+FiftyOne Teams 1.3.1
+--------------------
+*Released June 30, 2023*
+
+Includes all features from :ref:`FiftyOne 0.21.1 <release-notes-v0.21.1>`,
+plus:
+
+General
+
+- App containers no longer need to be restarted in order for Azure/MinIO
+  credentials uploaded via the Teams UI to be properly recognized
+- Fixed an intermittent bug when computing metadata for remote filepaths
+- Reverted a change from Teams 1.3.0 so that the SDK again supports the
+  declared minimum version requirement of `pymongo==3.12`
+
+API connections
+
+- Updated the order of precedence for SDK connections so that
+  :ref:`API connections <teams-api-connection>` take precedence over
+  :ref:`direct database connections <configuring-mongodb-connection>`
+- Fixed a bug when connecting to Teams deployments with non-standard database
+  names via API connections
+- Fixed a bug when deleting datasets using API connections
+
+Management SDK
+
+- Added support for
+  :ref:`deleting user invitations <teams-sdk-user-management>` by email in
+  addition to invitation ID
+- Added support for
+  :ref:`configuring permissions <teams-sdk-dataset-permissions>` for invited
+  users that have not yet logged in
+
+.. _release-notes-v0.21.1:
+
+FiftyOne 0.21.1
+---------------
+*Released June 30, 2023*
+
+App
+
+- Sidebar filters can now :ref:`leverage indexes <app-indexed-filtering>` for
+  improved performance!
+  `#3137 <https://github.com/voxel51/fiftyone/pull/3137>`_
+- Optimized the App grid's loading performance, especially for datasets with
+  large samples `#3137 <https://github.com/voxel51/fiftyone/pull/3137>`_
+- Improved the usability of the
+  :ref:`field visibility modal <app-field-visibility>`
+  `#3154 <https://github.com/voxel51/fiftyone/pull/3154>`_
+- Added support for visualizing Label fields stored within dynamic embedded
+  documents `#3141 <https://github.com/voxel51/fiftyone/pull/3141>`_
+- Added support for coloring embeddings plots by list fields
+  `#3230 <https://github.com/voxel51/fiftyone/pull/3230>`_
+- Added a `proxy_url` setting to the
+  :ref:`App config <configuring-fiftyone-app>` that allows for overriding the
+  server URL `#3222 <https://github.com/voxel51/fiftyone/pull/3222>`_
+- Added support for configuring :ref:`custom colors <app-color-schemes>` for
+  sample tags `#3171 <https://github.com/voxel51/fiftyone/pull/3171>`_
+- Fixed a bug that caused the point cloud selector from disappearing
+  `#3200 <https://github.com/voxel51/fiftyone/pull/3200>`_
+- Fixed various minor bugs when viewing
+  :ref:`dynamic groups <app-dynamic-groups>` in the App
+  `#3172 <https://github.com/voxel51/fiftyone/pull/3172>`_
+
+Core
+
+- Methods like
+  :meth:`tag_labels() <fiftyone.core.collections.SampleCollection.tag_labels>`,
+  :meth:`select_labels() <fiftyone.core.collections.SampleCollection.select_labels>`,
+  :meth:`export() <fiftyone.core.collections.SampleCollection.export>`, and
+  :meth:`draw_labels() <fiftyone.core.collections.SampleCollection.draw_labels>`
+  now automatically detect and properly handle label fields stored within
+  embedded documents
+  `#3152 <https://github.com/voxel51/fiftyone/pull/3152>`_
+- All |Document| objects now support ``doc["nested.field"]`` key access
+  `#3152 <https://github.com/voxel51/fiftyone/pull/3152>`_
+- Dynamic field detection now automatically detects dynamic attributes of list
+  fields with inhomogeneous values
+  `#3152 <https://github.com/voxel51/fiftyone/pull/3152>`_
+- Fixed a bug that would cause dynamic field schema methods to erroneously
+  declare subfields of |Polyline| points
+  `#3152 <https://github.com/voxel51/fiftyone/pull/3152>`_
+- Fixed a bug when applying
+  :meth:`merge_samples() <fiftyone.core.dataset.Dataset.merge_samples>` to
+  video dataset views
+  `#3159 <https://github.com/voxel51/fiftyone/pull/3159>`_
+
+Plugins
+
+- Added support for rendering markdown-style tables using the Operator table
+  view type `#3162 <https://github.com/voxel51/fiftyone/pull/3162>`_
+- Added support for multiselect to the Operator string type
+  `#3192 <https://github.com/voxel51/fiftyone/pull/3192>`_
+- Added `--all` flags to plugin CLI methods
+  `#3177 <https://github.com/voxel51/fiftyone/pull/3177>`_
+- Placements and on-startup hooks are now omitted for disabled Operators
+  `#3175 <https://github.com/voxel51/fiftyone/pull/3175>`_
+- Fixed a bug with `read_only=True` mode for certain Operator view types
+  `#3225 <https://github.com/voxel51/fiftyone/pull/3225>`_
+
+Annotation
+
+- Added support for CVAT's `frame_start`, `frame_stop`, and `frame_step`
+  options when creating annotation tasks
+  `#3181 <https://github.com/voxel51/fiftyone/pull/3181>`_
+
 .. _release-notes-teams-v1.3.0:
 
 FiftyOne Teams 1.3.0

docs/source/teams/management_sdk.rst

@@ -19,45 +19,57 @@ more.
 
 .. _teams-sdk-api-reference:
 
-API Reference
+API reference
 _____________
 
-Connection Methods
-------------------
+.. _teams-sdk-connections:
+
+Connections
+-----------
 
 .. automodule:: fiftyone.management.connection
    :members: test_api_connection, reload_connection
 
-API Key Management Methods
---------------------------
+.. _teams-sdk-api-keys:
+
+API keys
+--------
 
 .. automodule:: fiftyone.management.api_key
    :members:
    :undoc-members:
 
-Dataset Permission Management Methods
--------------------------------------
+.. _teams-sdk-dataset-permissions:
+
+Dataset permissions
+-------------------
 
 .. automodule:: fiftyone.management.dataset
    :members:
    :undoc-members:
 
-Organization Settings Methods
------------------------------
+.. _teams-sdk-organization-settings:
+
+Organization settings
+---------------------
 
 .. automodule:: fiftyone.management.organization
    :members:
    :undoc-members:
 
-Plugin Management Methods
--------------------------
+.. _teams-sdk-plugin-management:
+
+Plugin management
+-----------------
 
 .. automodule:: fiftyone.management.plugin
    :members:
    :undoc-members:
 
-User Management Methods
------------------------
+.. _teams-sdk-user-management:
+
+User management
+---------------
 
 .. automodule:: fiftyone.management.users
    :members:

docs/source/user_guide/app.rst

@@ -421,7 +421,7 @@ You can conveniently reset the sidebar groups to their default state by setting
 .. _app-filtering:
 
 Filtering sample fields
-_______________________
+-----------------------
 
 The App provides UI elements in both grid view and expanded sample view that
 you can use to filter your dataset. To view the available filter options for a
@@ -447,6 +447,37 @@ only those samples and/or labels that match the filter.
    :alt: app-filters
    :align: center
 
+.. _app-indexed-filtering:
+
+Leveraging indexes while filtering
+----------------------------------
+
+By default, most sidebar filters require full collection scans to retrieve the
+relevant results.
+
+However, you can optimize any sidebar filter(s) of interest by using
+:meth:`create_index() <fiftyone.core.collections.SampleCollection.create_index>`
+to index the field or embedded field that you wish to filter by:
+
+.. code-block:: python
+    :linenos:
+
+    import fiftyone as fo
+    import fiftyone.zoo as foz
+
+    dataset = foz.load_zoo_dataset("coco-2017", split="validation")
+
+    # Add index to optimize ground truth label filters
+    dataset.create_index("ground_truth.detections.label")
+
+    session = fo.launch_app(dataset)
+
+You can use
+:meth:`list_indexes() <fiftyone.core.collections.SampleCollection.list_indexes>`
+to view the existing indexes on a dataset, and you can use
+:meth:`drop_index() <fiftyone.core.collections.SampleCollection.drop_index>`
+to delete indexes that you no longer need.
+
 .. _app-create-view:
 
 Using the view bar