Skip to content

Commit

Permalink
Merge pull request #5250 from voxel51/main
Browse files Browse the repository at this point in the history
Merging main to develop
  • Loading branch information
brimoor authored Dec 10, 2024
2 parents 0948c7c + a035528 commit 42c6b18
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 4 deletions.
4 changes: 3 additions & 1 deletion docs/source/integrations/cvat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,7 @@ to CVAT is made.
export FIFTYONE_CVAT_USERNAME=...
export FIFTYONE_CVAT_PASSWORD=...
export FIFTYONE_CVAT_EMAIL=... # if applicable
**FiftyOne annotation config**

Expand All @@ -232,7 +233,8 @@ You can also store your credentials in your
"cvat": {
...
"username": ...,
"password": ...
"password": ...,
"email": ... # if applicable
}
}
}
Expand Down
5 changes: 5 additions & 0 deletions docs/source/plugins/developing_plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,7 @@ plugin's `fiftyone.yml` looks like this:
- FIFTYONE_CVAT_URL
- FIFTYONE_CVAT_USERNAME
- FIFTYONE_CVAT_PASSWORD
- FIFTYONE_CVAT_EMAIL
- FIFTYONE_LABELBOX_URL
- FIFTYONE_LABELBOX_API_KEY
- FIFTYONE_LABELSTUDIO_URL
Expand Down Expand Up @@ -1528,6 +1529,7 @@ plugin declares the following secrets:
- FIFTYONE_CVAT_URL
- FIFTYONE_CVAT_USERNAME
- FIFTYONE_CVAT_PASSWORD
- FIFTYONE_CVAT_EMAIL
- FIFTYONE_LABELBOX_URL
- FIFTYONE_LABELBOX_API_KEY
- FIFTYONE_LABELSTUDIO_URL
Expand All @@ -1544,6 +1546,7 @@ plugin, you would set:
FIFTYONE_CVAT_URL=...
FIFTYONE_CVAT_USERNAME=...
FIFTYONE_CVAT_PASSWORD=...
FIFTYONE_CVAT_EMAIL=...
At runtime, the plugin's :ref:`execution context <operator-execution-context>`
is automatically hydrated with any available secrets that are declared by the
Expand All @@ -1556,6 +1559,7 @@ plugin. Operators can access these secrets via the `ctx.secrets` dict:
url = ctx.secrets["FIFTYONE_CVAT_URL"]
username = ctx.secrets["FIFTYONE_CVAT_USERNAME"]
password = ctx.secrets["FIFTYONE_CVAT_PASSWORD"]
email = ctx.secrets["FIFTYONE_CVAT_EMAIL"]
.. _operator-outputs:

Expand Down Expand Up @@ -2501,6 +2505,7 @@ plugin. Panels can access these secrets via the `ctx.secrets` dict:
url = ctx.secrets["FIFTYONE_CVAT_URL"]
username = ctx.secrets["FIFTYONE_CVAT_USERNAME"]
password = ctx.secrets["FIFTYONE_CVAT_PASSWORD"]
email = ctx.secrets["FIFTYONE_CVAT_EMAIL"]
.. _panel-common-patterns:

Expand Down
4 changes: 4 additions & 0 deletions docs/source/plugins/using_plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,7 @@ available metadata about a plugin:
secrets FIFTYONE_CVAT_URL
FIFTYONE_CVAT_USERNAME
FIFTYONE_CVAT_PASSWORD
FIFTYONE_CVAT_EMAIL
FIFTYONE_LABELBOX_URL
FIFTYONE_LABELBOX_API_KEY
FIFTYONE_LABELSTUDIO_URL
Expand Down Expand Up @@ -469,6 +470,7 @@ plugin declares the following secrets:
- FIFTYONE_CVAT_URL
- FIFTYONE_CVAT_USERNAME
- FIFTYONE_CVAT_PASSWORD
- FIFTYONE_CVAT_EMAIL
- FIFTYONE_LABELBOX_URL
- FIFTYONE_LABELBOX_API_KEY
- FIFTYONE_LABELSTUDIO_URL
Expand All @@ -491,6 +493,7 @@ plugin, you would set:
FIFTYONE_CVAT_URL=...
FIFTYONE_CVAT_USERNAME=...
FIFTYONE_CVAT_PASSWORD=...
FIFTYONE_CVAT_EMAIL=...
At runtime, the plugin's execution context will automatically be hydrated with
any available secrets that are declared by the plugin. Operators access these
Expand All @@ -503,6 +506,7 @@ secrets via the `ctx.secrets` dict:
url = ctx.secrets["FIFTYONE_CVAT_URL"]
username = ctx.secrets["FIFTYONE_CVAT_USERNAME"]
password = ctx.secrets["FIFTYONE_CVAT_PASSWORD"]
email = ctx.secrets["FIFTYONE_CVAT_EMAIL"]
.. _using-panels:

Expand Down
4 changes: 4 additions & 0 deletions docs/source/release-notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ App
`#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>`_
- Added a `referrerPolicy` so the App can run behind reverse proxies
`#4944 <https://github.com/voxel51/fiftyone/pull/4944>`_
- Fixed a bug that prevented video playback from working for videos with
unknown frame rate
`#5155 <https://github.com/voxel51/fiftyone/pull/5155>`_
Expand All @@ -61,6 +63,8 @@ SDK
:meth:`max() <fiftyone.core.collections.SampleCollection.max>` and
aggregations
`#5029 <https://github.com/voxel51/fiftyone/pull/5029>`_
- Optimized object detection evaluation with r-trees
`#4758 <https://github.com/voxel51/fiftyone/pull/4758>`_
- 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
Expand Down
2 changes: 2 additions & 0 deletions docs/source/teams/secrets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ plugin declares the following secrets:
- FIFTYONE_CVAT_URL
- FIFTYONE_CVAT_USERNAME
- FIFTYONE_CVAT_PASSWORD
- FIFTYONE_CVAT_EMAIL
- FIFTYONE_LABELBOX_URL
- FIFTYONE_LABELBOX_API_KEY
- FIFTYONE_LABELSTUDIO_URL
Expand All @@ -83,6 +84,7 @@ secrets via the ``ctx.secrets`` dict:
url = ctx.secrets["FIFTYONE_CVAT_URL"]
username = ctx.secrets["FIFTYONE_CVAT_USERNAME"]
password = ctx.secrets["FIFTYONE_CVAT_PASSWORD"]
email = ctx.secrets["FIFTYONE_CVAT_EMAIL"]
The ``ctx.secrets`` dict will also be automatically populated with the
values of any environment variables whose name matches a secret key declared
Expand Down
5 changes: 3 additions & 2 deletions docs/source/tutorials/cvat_annotation.ipynb

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion docs/source/user_guide/annotation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -357,13 +357,15 @@ settings that you declare in this way will be passed as keyword arguments to
methods like
:meth:`annotate() <fiftyone.core.collections.SampleCollection.annotate>`
whenever the corresponding backend is in use. For example, you can configure
the URL, username, and password of your CVAT server as follows:
the URL, username, password, and email (if applicable) of your CVAT server as
follows:

.. code-block:: shell
export FIFTYONE_CVAT_URL=http://localhost:8080
export FIFTYONE_CVAT_USERNAME=...
export FIFTYONE_CVAT_PASSWORD=...
export FIFTYONE_CVAT_EMAIL=... # if applicable
The `FIFTYONE_ANNOTATION_BACKENDS` environment variable can be set to a
`list,of,backends` that you want to expose in your session, which may exclude
Expand Down

0 comments on commit 42c6b18

Please sign in to comment.