Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Features + release notes #5188

Merged
merged 6 commits into from
Dec 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
584 changes: 326 additions & 258 deletions docs/source/brain.rst

Large diffs are not rendered by default.

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
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.
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.
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/teams/data_quality_home.png
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 support@voxel51.com.
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
141 changes: 136 additions & 5 deletions docs/source/release-notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,147 @@ FiftyOne Release Notes

.. default-role:: code

FiftyOne Teams 2.2.0
--------------------
*Released December 4, 2024*

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should there be a note about invitations and/or any other non-samples related changes?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yes, added a note for SMTP configuration 👍


- 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>`
- Added support for :ref:`configuring an SMTP server <identity-providers>` for
sending user invitiations via email when running in
:ref:`Internal Mode <internal-mode>`

.. _release-notes-v1.1.0:

FiftyOne 1.1.0
--------------
*Released December 4, 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
- Added a :ref:`leaky splits method <brain-leaky-splits>` for automatically
detecting near-duplicate samples in different splits of your datasets
- Added a :ref:`near duplicates method <brain-near-duplicates>` that scans
your datasets and detects potential duplicate samples

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added skip_prompt - that should be in here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added thanks 👍


- 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>`_
- Added a `skip_prompt` option to
:meth:`ctx.prompt <fiftyone.operators.executor.ExecutionContext.prompt>`,
allowing users to bypass prompts during operation execution
`#4992 <https://github.com/voxel51/fiftyone/pull/4992>`_
- 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 +182,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 Expand Up @@ -4295,7 +4426,7 @@ Annotation
Docs

- Added a :doc:`CVAT annotation tutorial </tutorials/cvat_annotation>`
- Added a :ref:`new example <brain-similarity-cifar10>` to the brain user guide
- Added a :ref:`new example <brain-near-duplicates>` to the brain user guide
that demonstrates unique and near-duplicate image workflows
- Added an object embeddings example to the
:ref:`embeddings visualization section <brain-embeddings-visualization>` of
Expand Down
Loading
Loading