Skip to content

Commit

Permalink
Merge branch 'release/v1.4.0' of https://github.com/voxel51/fiftyone
Browse files Browse the repository at this point in the history
…into develop
  • Loading branch information
voxel51-bot committed Mar 11, 2025
2 parents d9e1287 + eee32c4 commit 0f2475f
Show file tree
Hide file tree
Showing 130 changed files with 798 additions and 780 deletions.
8 changes: 4 additions & 4 deletions docs/source/_templates/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
<div class="arrow-up--light-primary arrow-left20"></div>
<ul>
<li><a href="{{link_fiftyone}}">Open Source</a></li>
<li><a href="{{link_fiftyone_teams}}">FiftyOne Teams</a></li>
<li><a href="{{link_fiftyone_enterprise}}">Enterprise</a></li>
<li><a href="{{link_usecases}}">Use Cases</a></li>
<li><a href="{{link_success_stories}}">Success Stories</a></li>
</ul>
Expand All @@ -54,7 +54,7 @@
<div class="nav__item nav__dropdown__menu has-arrows">
<div class="arrow-up--light-primary arrow-left20"></div>
<ul>
<li><a href="{{link_voxel51_discord}}">Community Discord</a></li>
<li><a href="{{link_voxel51_discord}}">Discord</a></li>
<li><a href="{{link_voxel51_blog}}">Blog</a></li>
<li><a href="{{link_events}}">Events</a></li>
</ul>
Expand Down Expand Up @@ -130,8 +130,8 @@
<div class="footer__links">
<div class="footer__links--col2">
<p class="nav__item--brand">Products</p>
<a href="{{link_fiftyone}}">FiftyOne</a>
<a href="{{link_fiftyone_teams}}">FiftyOne Teams</a>
<a href="{{link_fiftyone}}">Open Source</a>
<a href="{{link_fiftyone_enterprise}}">Enterprise</a>
<a href="{{link_usecases}}">Use Cases</a>
<a href="{{link_success_stories}}">Success Stories</a>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/source/cheat_sheets/fiftyone_terminology.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ __________
- The :ref:`provided user interface <fiftyone-app>` for graphically
viewing, filtering, and understanding your datasets. Can be launched in
the browser or within notebooks.
* - FiftyOne Teams
- `The enterprise-grade suite <https://voxel51.com/fiftyone-teams/>`_
* - FiftyOne Enterprise
- `The enterprise-grade suite <https://voxel51.com/enterprise/>`_
built on top of FiftyOne for collaboration, permissioning, and working
with cloud-backed media.

Expand Down
4 changes: 2 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -192,11 +192,11 @@
"link_contactus": "mailto:[email protected]?subject=[Voxel51]%20Contact%20us",
"link_docs_fiftyone": "https://docs.voxel51.com/",
"link_fiftyone": "https://voxel51.com/fiftyone/",
"link_fiftyone_teams": "https://voxel51.com/fiftyone-teams/",
"link_fiftyone_enterprise": "https://voxel51.com/enterprise/",
"link_usecases": "https://voxel51.com/computer-vision-use-cases/",
"link_success_stories": "https://voxel51.com/success-stories/",
"link_talk_to_sales": "https://voxel51.com/talk-to-sales/",
"link_workshop": "https://voxel51.com/schedule-teams-workshop/",
"link_workshop": "https://voxel51.com/book-a-demo/",
"link_fiftyone_tutorials": "https://docs.voxel51.com/tutorials/index.html",
"link_fiftyone_examples": "https://github.com/voxel51/fiftyone-examples",
"link_fiftyone_quickstart": "https://colab.research.google.com/github/voxel51/fiftyone-examples/blob/master/examples/quickstart.ipynb",
Expand Down
2 changes: 1 addition & 1 deletion docs/source/deprecation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Kubernetes 1.27
*Support ended November 1, 2024*

`Kubernetes 1.27 <https://kubernetes.io/releases/>`_
transitioned to `end-of-life` effective July of 2024. FiftyOne Teams
transitioned to `end-of-life` effective July of 2024. FiftyOne Enterprise
releases after October 31, 2024 might no longer be compatible with
Kubernetes 1.27 and older.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
.. _teams-api-connection:
.. _enterprise-api-connection:

API Connection
==============

.. default-role:: code

This page describes how to create API keys and configure your
:ref:`SDK installation <teams-python-sdk>` to connect to your Teams
:ref:`SDK installation <enterprise-python-sdk>` to connect to your Enterprise
deployment's API.

All actions taken via API connections are authenticated based on the user
Expand All @@ -16,7 +16,7 @@ dataset permissions *are enforced*.
.. note::

**API connections are currently in beta.** The recommended stable solution
is to use your Teams deployment's
is to use your Enterprise deployment's
:ref:`MongoDB connection <configuring-mongodb-connection>`.

.. _configuring-an-api-connection:
Expand All @@ -27,32 +27,32 @@ Configuring an API connection
You can configure an API connection by adding an API URI and API key to your
FiftyOne config as described below:

+-------------------------------+-------------------------------------+----------------------------------------------------------------------------------------+
| Config field | Environment variable | Description |
+===============================+=====================================+========================================================================================+
| `api_uri` | `FIFTYONE_API_URI` | The URI of your FiftyOne Teams API. Ask your deployment admin for this value. |
+-------------------------------+-------------------------------------+----------------------------------------------------------------------------------------+
| `api_key` | `FIFTYONE_API_KEY` | Your FiftyOne Teams API key. :ref:`See here <teams-generate-api-key>` to generate one. |
+-------------------------------+-------------------------------------+----------------------------------------------------------------------------------------+
+-------------------------------+-------------------------------------+--------------------------------------------------------------------------------------------------+
| Config field | Environment variable | Description |
+===============================+=====================================+==================================================================================================+
| `api_uri` | `FIFTYONE_API_URI` | The URI of your FiftyOne Enterprise API. Ask your deployment admin for this value. |
+-------------------------------+-------------------------------------+--------------------------------------------------------------------------------------------------+
| `api_key` | `FIFTYONE_API_KEY` | Your FiftyOne Enterprise API key. :ref:`See here <enterprise-generate-api-key>` to generate one. |
+-------------------------------+-------------------------------------+--------------------------------------------------------------------------------------------------+

For example, you can set environment variables:

.. code-block:: shell
export FIFTYONE_API_URI==XXXXXXXX
export FIFTYONE_API_KEY==YYYYYYYY
export FIFTYONE_API_URI=XXXXXXXX
export FIFTYONE_API_KEY=YYYYYYYY
See
:ref:`this page <configuring-fiftyone>` for more information about using your
FiftyOne config.

.. _teams-generate-api-key:
.. _enterprise-generate-api-key:

Generating an API key
---------------------

Users can generate and manage API keys via the UI or the
:ref:`Management SDK <teams-management-sdk>`.
:ref:`Management SDK <enterprise-management-sdk>`.

.. note::

Expand All @@ -62,21 +62,21 @@ Generating keys via the UI
~~~~~~~~~~~~~~~~~~~~~~~~~~

You can access API key management features by clicking on your account icon in
the upper-right of the FiftyOne Teams App and navigating to the
the upper-right of the FiftyOne Enterprise App and navigating to the
"Settings > API keys" page.

A new key can be generated by clicking on "Generate API key" and optionally
providing a nickname for the key to identify what it is used for. Click
"Generate key" to complete the process.

.. image:: /images/teams/api_key_generate.png
.. image:: /images/enterprise/api_key_generate.png
:alt: api-key-generate
:align: center

Finally, copy the key and configure it locally using one of the options
:ref:`described here <teams-api-connection>`.
:ref:`described here <enterprise-api-connection>`.

.. image:: /images/teams/api_key_generated.png
.. image:: /images/enterprise/api_key_generated.png
:alt: api-key-generated
:align: center

Expand All @@ -97,15 +97,15 @@ generate API keys programmatically.

Admins can generate API keys for other users, if desired.

.. _teams-delete-api-key:
.. _enterprise-delete-api-key:

Deleting an API key
-------------------

To delete a key and remove its access, find the key to delete in the list and
click "Delete".

.. image:: /images/teams/api_key_delete.png
.. image:: /images/enterprise/api_key_delete.png
:alt: api-key-delete
:align: center

Expand Down
Loading

0 comments on commit 0f2475f

Please sign in to comment.