Skip to content

Commit

Permalink
docs and release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
brimoor committed Nov 26, 2024
1 parent ac6799c commit b4eea4e
Show file tree
Hide file tree
Showing 22 changed files with 642 additions and 273 deletions.
4 changes: 2 additions & 2 deletions docs/source/dataset_zoo/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ load into FiftyOne with a single command.
:button_text: Explore the datasets in the zoo
:button_link: datasets.html

Remotely-sourced datasets __SUB_NEW__
-------------------------------------
Remotely-sourced datasets
-------------------------

The Dataset Zoo also supports loading datasets whose download/preparation
methods are provided via GitHub repositories or URLs.
Expand Down
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/images/app/model-evaluation-notes.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/images/app/model-evaluation-open.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/source/images/teams/qp_toggle.png
Binary file not shown.
4 changes: 2 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -487,8 +487,8 @@ us at [email protected].
Recipes <recipes/index>
Cheat Sheets <cheat_sheets/index>
User Guide <user_guide/index>
Dataset Zoo __SUB_NEW__ <dataset_zoo/index>
Model Zoo __SUB_NEW__ <model_zoo/index>
Dataset Zoo <dataset_zoo/index>
Model Zoo <model_zoo/index>
FiftyOne Brain <brain>
Integrations <integrations/index>
Plugins <plugins/index>
Expand Down
4 changes: 2 additions & 2 deletions docs/source/model_zoo/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ you can apply to your datasets with a few simple commands.
:meth:`apply_model() <fiftyone.core.collections.SampleCollection.apply_model>`
and :meth:`compute_embeddings() <fiftyone.core.collections.SampleCollection.compute_embeddings>`!

Remotely-sourced models __SUB_NEW__
-----------------------------------
Remotely-sourced models
-----------------------

The Model Zoo also supports downloading and applying models whose definitions
are provided via GitHub repositories or URLs.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/plugins/developing_plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2382,7 +2382,7 @@ loaded only when the `brain_key` property is modified.
Panel data is never readable in Python; it is only implicitly used by
the types you define when they are rendered clientside.

.. _panel-execution-store
.. _panel-execution-store:

Execution store
---------------
Expand Down
128 changes: 124 additions & 4 deletions docs/source/release-notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,136 @@ FiftyOne Release Notes

.. default-role:: code

FiftyOne Teams 2.2.0
--------------------
*Released November 26, 2024*

Includes all updates from :ref:`FiftyOne 1.1.0 <release-notes-v1.1.0>`, plus:

- All Teams deployments now have builtin compute capacity for
executing :ref:`delegated operations <teams-delegated-operations>` in the
background while you work in the App
- Introduced :ref:`Data Lens <data-lens>`, which allows you to explore and
import samples from external data sources into FiftyOne
- Added a :ref:`Data Quality Panel <data-quality>` that automatically scans
your data for quality issues and helps you take action to resolve them
- Added a :ref:`Query Performance Panel <query-performance>` that helps you
create the necessary indexes to optimize queries on large datasets
- Added support for creating embeddings visualizations natively from the
:ref:`Embeddings panel <app-embeddings-panel>`
- Added support for evaluating models natively from the
:ref:`Modal Evaluation panel <app-model-evaluation-panel>`

.. _release-notes-v1.1.0:

FiftyOne 1.1.0
--------------
*Released November 26, 2024*

What's New

- Added a :ref:`Model Evaluation panel <app-model-evaluation-panel>` for
visually and interactively evaluating models in the FiftyOne App
- Introduced :ref:`Query Performance <app-optimize-query-performance>` in the
App, which automatically nudges you to create the necessary indexes to
greatly optimize queries on large datasets

App

- Added zoom-to-crop and set-look-at for selected labels in the
:ref:`3D visualizer <app-3d-visualizer>`
`#4931 <https://github.com/voxel51/fiftyone/pull/4931>`_
- Gracefully handle deleted + recreated datasets of the same name
`#5183 <https://github.com/voxel51/fiftyone/pull/5183>`_
- Fixed a bug that prevented video playback from working for videos with
unknown frame rate
`#5155 <https://github.com/voxel51/fiftyone/pull/5155>`_

SDK

- Added :meth:`min() <fiftyone.core.collections.SampleCollection.min>` and
:meth:`max() <fiftyone.core.collections.SampleCollection.max>` and
aggregations
`#5029 <https://github.com/voxel51/fiftyone/pull/5029>`_
- Improved support for creating summary fields and indexes
`#5091 <https://github.com/voxel51/fiftyone/pull/5091>`_
- Added support for creating compound indexes when using the builtin
:class:`create_index <fiftyone.operators.builtin.CreateIndex>` operator that
optimize sidebar queries for group datasets
`#5174 <https://github.com/voxel51/fiftyone/pull/5174>`_
- The builtin
:class:`clear_sample_field <fiftyone.operators.builtin.ClearSampleField>`
and
:class:`clear_frame_field <fiftyone.operators.builtin.ClearFrameField>`
operators now support clearing fields of views, in addition to full datasets
`#5122 <https://github.com/voxel51/fiftyone/pull/5122>`_
- Fixed a bug that prevented users with `pydantic` installed from loading the
:ref:`quickstart-3d dataset <dataset-zoo-quickstart-3d>` from the zoo
`#4994 <https://github.com/voxel51/fiftyone/pull/4994>`_

Brain

- Added support for passing existing
:ref:`similarity indexes <brain-similarity>` to
:func:`compute_visualization() <fiftyone.brain.compute_visualization>`,
:func:`compute_uniqueness() <fiftyone.brain.compute_uniqueness>`, and
:func:`compute_representativeness() <fiftyone.brain.compute_representativeness>`
`#201 <https://github.com/voxel51/fiftyone-brain/pull/201>`_,
`#204 <https://github.com/voxel51/fiftyone-brain/pull/204>`_
- Upgraded the :ref:`Pinecone integration <pinecone-integration>` to support
`pinecone-client>=3.2`
`#202 <https://github.com/voxel51/fiftyone-brain/pull/202>`_

Plugins

- Added an :ref:`Execution Store <panel-execution-store>` that provides a
key-value interface for persisting data beyond the lifetime of a panel
`#4827 <https://github.com/voxel51/fiftyone/pull/4827>`_,
`#5144 <https://github.com/voxel51/fiftyone/pull/5144>`_
- Added
:meth:`ctx.spaces <fiftyone.operators.executor.ExecutionContext.spaces>`
and
:meth:`set_spaces() <fiftyone.operators.operations.Operations.set_spaces>`
to the operator execution context
`#4902 <https://github.com/voxel51/fiftyone/pull/4902>`_
- Added
:meth:`open_sample() <fiftyone.operators.operations.Operations.open_sample>`
and
:meth:`close_sample() <fiftyone.operators.operations.Operations.close_sample>`
methods for programmatically controlling what sample(s) are displayed in the
App's sample modal
`#5168 <https://github.com/voxel51/fiftyone/pull/5168>`_
- Introduced a new
:class:`StatusButtonView <fiftyone.operators.types.StatusButtonView>` type
for rendering buttons with status indicators
`#5105 <https://github.com/voxel51/fiftyone/pull/5105>`_
- Added support for giving
:class:`ImageView <fiftyone.operators.types.ImageView>` components click
targets
`#4996 <https://github.com/voxel51/fiftyone/pull/4996>`_
- Added an :ref:`allow_legacy_orchestrators <configuring-fiftyone>` config flag
to enable running delegated operations
:ref:`locally <delegated-orchestrator-open-source>`
`#5176 <https://github.com/voxel51/fiftyone/pull/5176>`_
- Fixed a bug when running delegated operations
:ref:`programmatically <direct-operator-execution>`
`#5180 <https://github.com/voxel51/fiftyone/pull/5180>`_
- Fixed a bug when running delegated operations with output schemas on
MongoDB <v5
`#5181 <https://github.com/voxel51/fiftyone/pull/5181>`_


FiftyOne Teams 2.1.3
--------------------
*Released November XX, 2024*
*Released November 8, 2024*

Includes all updates from :ref:`FiftyOne 1.0.2 <release-notes-v1.0.2>`
Includes all updates from :ref:`FiftyOne 1.0.2 <release-notes-v1.0.2>`.

.. _release-notes-v1.0.3:
.. _release-notes-v1.0.2:

FiftyOne 1.0.2
--------------
*Released November XX, 2024*
*Released November 8, 2024*

Zoo

Expand Down Expand Up @@ -52,6 +171,7 @@ App
- Fixed batch selection with ctrl + click in the grid
`#5046 <https://github.com/voxel51/fiftyone/pull/5046>`_


FiftyOne Teams 2.1.2
--------------------
*Released October 31, 2024*
Expand Down
13 changes: 13 additions & 0 deletions docs/source/teams/data_quality.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.. _data-quality:

Data Quality Issues
===================

.. default-role:: code

**Available in FiftyOne Teams v2.2+**

The Data Quality panel is a builtin feature of the
:ref:`FiftyOne Teams App <teams-app>` that automatically scans your dataset
for common quality issues and helps you explore and take action to resolve
them.
23 changes: 21 additions & 2 deletions docs/source/teams/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,11 +93,29 @@ pages on this site apply to Teams deployments as well.
:button_link: teams_app.html

.. customcalloutitem::
:header: Data Lens
:header: Data Lens __SUB_NEW__
:description: Use FiftyOne Teams to explore and import samples from external data sources.
:button_text: Connect your data lake
:button_link: data_lens.html

.. customcalloutitem::
:header: Data Quality __SUB_NEW__
:description: Automatically scan your data for quality issues and take action to resolve them.
:button_text: Find quality issues
:button_link: data_quality.html

.. customcalloutitem::
:header: Model Evaluation __SUB_NEW__
:description: Evaluate your models and interactively and visually analyze their performance.
:button_text: Evaluate models
:button_link: ../user_guide/evaluation.html

.. customcalloutitem::
:header: Query Performance __SUB_NEW__
:description: Configure your massive datasets to support fast queries at scale.
:button_text: Fast queries at scale
:button_link: query_performance.html

.. customcalloutitem::
:header: Plugins
:description: Learn how to install and manage shared plugins for your Teams deployment.
Expand Down Expand Up @@ -149,8 +167,9 @@ pages on this site apply to Teams deployments as well.
Dataset Versioning <dataset_versioning>
FiftyOne Teams App <teams_app>
Data Lens __SUB_NEW__ <data_lens>
Data Quality __SUB_NEW__ <data_quality>
Query Performance __SUB_NEW__ <query_performance>
Plugins <teams_plugins>
Query Performance <query_performance>
Secrets <secrets>
Management SDK <management_sdk>
Migrations <migrations>
Expand Down
Loading

0 comments on commit b4eea4e

Please sign in to comment.