diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html index e0d3a5add47..646002558b8 100644 --- a/docs/source/_templates/layout.html +++ b/docs/source/_templates/layout.html @@ -42,7 +42,7 @@
@@ -54,7 +54,7 @@
@@ -130,8 +130,8 @@

Products

- FiftyOne - FiftyOne Teams + Open Source + Enterprise Use Cases Success Stories
diff --git a/docs/source/cheat_sheets/fiftyone_terminology.rst b/docs/source/cheat_sheets/fiftyone_terminology.rst index d3a74eee469..546eec94299 100644 --- a/docs/source/cheat_sheets/fiftyone_terminology.rst +++ b/docs/source/cheat_sheets/fiftyone_terminology.rst @@ -20,8 +20,8 @@ __________ - The :ref:`provided user interface ` for graphically viewing, filtering, and understanding your datasets. Can be launched in the browser or within notebooks. - * - FiftyOne Teams - - `The enterprise-grade suite `_ + * - FiftyOne Enterprise + - `The enterprise-grade suite `_ built on top of FiftyOne for collaboration, permissioning, and working with cloud-backed media. diff --git a/docs/source/conf.py b/docs/source/conf.py index 815a62ed640..6eca02aab95 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -192,11 +192,11 @@ "link_contactus": "mailto:solutions@voxel51.com?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", diff --git a/docs/source/deprecation.rst b/docs/source/deprecation.rst index e3d919cf766..c671c7a82ce 100644 --- a/docs/source/deprecation.rst +++ b/docs/source/deprecation.rst @@ -32,7 +32,7 @@ Kubernetes 1.27 *Support ended November 1, 2024* `Kubernetes 1.27 `_ -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. diff --git a/docs/source/teams/api_connection.rst b/docs/source/enterprise/api_connection.rst similarity index 75% rename from docs/source/teams/api_connection.rst rename to docs/source/enterprise/api_connection.rst index f8f5fb6f388..d73ecc60f4f 100644 --- a/docs/source/teams/api_connection.rst +++ b/docs/source/enterprise/api_connection.rst @@ -1,4 +1,4 @@ -.. _teams-api-connection: +.. _enterprise-api-connection: API Connection ============== @@ -6,7 +6,7 @@ API Connection .. default-role:: code This page describes how to create API keys and configure your -:ref:`SDK installation ` to connect to your Teams +:ref:`SDK installation ` to connect to your Enterprise deployment's API. All actions taken via API connections are authenticated based on the user @@ -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-an-api-connection: @@ -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 ` 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 ` 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 ` 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 `. +:ref:`Management SDK `. .. note:: @@ -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 `. +:ref:`described here `. -.. image:: /images/teams/api_key_generated.png +.. image:: /images/enterprise/api_key_generated.png :alt: api-key-generated :align: center @@ -97,7 +97,7 @@ 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 ------------------- @@ -105,7 +105,7 @@ 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 diff --git a/docs/source/teams/teams_app.rst b/docs/source/enterprise/app.rst similarity index 69% rename from docs/source/teams/teams_app.rst rename to docs/source/enterprise/app.rst index ae4d9abfb7e..6475418fa8a 100644 --- a/docs/source/teams/teams_app.rst +++ b/docs/source/enterprise/app.rst @@ -1,24 +1,24 @@ -.. _teams-app: +.. _enterprise-app: -FiftyOne Teams App -================== +FiftyOne Enterprise App +======================= .. default-role:: code -The FiftyOne Teams App allows you to visualize, browse, and interact with your +The FiftyOne Enterprise App allows you to visualize, browse, and interact with your individual datasets like you can with the :ref:`FiftyOne App `, but with expanded features for organizing, permissionsing, versioning, and sharing your team's datasets, all from a centralized web portal. This page provides a brief overview of some features available only in the -FiftyOne Teams App. +FiftyOne Enterprise App. -.. _teams-homepage: +.. _enterprise-homepage: The homepage ____________ -When you login to the FiftyOne Teams App, you'll land on the homepage pictured +When you login to the FiftyOne Enterprise App, you'll land on the homepage pictured below. In the top bar of this page, on the left side, the gray number next to @@ -28,14 +28,14 @@ buttons at the bottom of the page to see different batches of datasets. .. note:: - You can return to the homepage from any page of the Teams App by clicking on + You can return to the homepage from any page of the Enterprise App by clicking on the Voxel51 logo in the upper left corner. -.. image:: /images/teams/homepage.png +.. image:: /images/enterprise/homepage.png :alt: app-homepage :align: center -.. _teams-pinned-datasets: +.. _enterprise-pinned-datasets: Pinned datasets --------------- @@ -52,12 +52,12 @@ To unpin a dataset, click the pin icon next to the dataset name in the "Your pinned datasets" widget or the pin next to the dataset's name in the main table. -.. image:: /images/teams/pinned_datasets.png +.. image:: /images/enterprise/pinned_datasets.png :alt: pin-datasets :align: center :width: 500 -.. _teams-sorting-datasets: +.. _enterprise-sorting-datasets: Sorting datasets ---------------- @@ -66,12 +66,12 @@ You can use the drop-down menu in the upper left of the main table to sort your datasets by various criteria, including size, creation date, recently used, and alphabetically by name: -.. image:: /images/teams/ordering_datasets.png +.. image:: /images/enterprise/ordering_datasets.png :alt: order-datasets :align: center :width: 500 -.. _teams-filtering-datasets: +.. _enterprise-filtering-datasets: Filtering datasets ------------------ @@ -79,7 +79,7 @@ Filtering datasets You can use the search bar (with the magnifying glass icon) in the upper right corner of the dataset table to filter datasets by name, tags, and media type: -.. image:: /images/teams/dataset_search_bar.png +.. image:: /images/enterprise/dataset_search_bar.png :alt: dataset-search-bar :align: center :width: 500 @@ -88,12 +88,12 @@ By default, datasets that match across any supported field are returned, but you can narrow the search to specific fields by selecting the relevant option in the search dropdown: -.. image:: /images/teams/dataset_search_fields.png +.. image:: /images/enterprise/dataset_search_fields.png :alt: dataset-search-fields :align: center :width: 500 -.. _teams-creating-datasets: +.. _enterprise-creating-datasets: Creating datasets _________________ @@ -118,19 +118,19 @@ description, and tags for the dataset: .. note:: A dataset's name, description, and tags can be edited later from the - dataset's :ref:`Manage tab `. + dataset's :ref:`Manage tab `. -.. image:: /images/teams/create_dataset.png +.. image:: /images/enterprise/create_dataset.png :alt: create-dataset :align: center .. note:: - What next? Use the :ref:`Teams Python SDK ` to upload new + What next? Use the :ref:`Enterprise Python SDK ` to upload new samples, labels, and metadata to your dataset. A common approach is to - automate this process via :ref:`cloud functions `. + automate this process via :ref:`cloud functions `. -.. _teams-using-datasets: +.. _enterprise-using-datasets: Using a dataset _______________ @@ -140,7 +140,7 @@ Click on a dataset from the homepage to open the dataset's "Samples" tab. From the Samples tab you can visualize, tag, filter, and explore your dataset just as you would via the :ref:`FiftyOne App `. -.. image:: /images/teams/samples_page.png +.. image:: /images/enterprise/samples_page.png :alt: samples-page :align: center @@ -149,74 +149,74 @@ just as you would via the :ref:`FiftyOne App `. Did you know? You can also navigate directly to a dataset of interest by pasting its URL into your browser's URL bar. -.. _teams-managing-datasets: +.. _enterprise-managing-datasets: Managing a dataset __________________ -The FiftyOne Teams App provides a number of options for managing existing +The FiftyOne Enterprise App provides a number of options for managing existing datasets, as described below. -You can access these options from the :ref:`Samples tab ` +You can access these options from the :ref:`Samples tab ` by clicking on the "Manage" tab in the upper left corner of the page. You can also directly navigate to this page from the -:ref:`homepage ` by clicking the three dots on the +:ref:`homepage ` by clicking the three dots on the right hand side of a row of the dataset listing table and selecting "Edit dataset". .. note:: - Did you know? You can also use the :ref:`Teams SDK ` to + Did you know? You can also use the :ref:`Enterprise SDK ` to programmatically, create, edit, and delete datasets. -.. _teams-dataset-basic-info: +.. _enterprise-dataset-basic-info: Basic info ---------- The "Basic info" tab is accessible to all users with -:ref:`Can view ` access to the dataset. +:ref:`Can view ` access to the dataset. -Users with :ref:`Can manage ` permissions on the dataset can +Users with :ref:`Can manage ` permissions on the dataset can edit the name, description, and tags of a dataset from this page. Additionally, members can create a copy of the dataset by clicking on the "Clone this dataset" button. -.. image:: /images/teams/dataset_basic_info.png +.. image:: /images/enterprise/dataset_basic_info.png :alt: dataset-basic-info :align: center -.. _teams-dataset-access: +.. _enterprise-dataset-access: Access ------ The "Access" tab is only accessible to users with -:ref:`Can manage ` permissions on the dataset. +:ref:`Can manage ` permissions on the dataset. From this tab, users can add, remove, edit, or invite users to the dataset. -Refer to :ref:`this page ` for more information about the +Refer to :ref:`this page ` for more information about the available dataset-level permissions that you can grant. -.. image:: /images/teams/dataset_access.png +.. image:: /images/enterprise/dataset_access.png :alt: dataset-access :align: center -.. _teams-dataset-danger-zone: +.. _enterprise-dataset-danger-zone: Danger zone ----------- The "Danger zone" tab is only accessible to users with -:ref:`Can manage ` permissions on the dataset. +:ref:`Can manage ` permissions on the dataset. From this tab, you can select "Delete entire dataset" to permanently delete a -dataset from your Teams deployment. You must type the dataset's full name in +dataset from your Enterprise deployment. You must type the dataset's full name in the modal to confirm this action. -.. image:: /images/teams/dataset_danger_zone.png +.. image:: /images/enterprise/dataset_danger_zone.png :alt: danger-zone :align: center diff --git a/docs/source/teams/cloud_media.rst b/docs/source/enterprise/cloud_media.rst similarity index 93% rename from docs/source/teams/cloud_media.rst rename to docs/source/enterprise/cloud_media.rst index c9cac450d40..d4077808865 100644 --- a/docs/source/teams/cloud_media.rst +++ b/docs/source/enterprise/cloud_media.rst @@ -1,25 +1,25 @@ -.. _teams-cloud-media: +.. _enterprise-cloud-media: Cloud-Backed Media ================== .. default-role:: code -FiftyOne Teams datasets may contain samples whose filepath refers to cloud +FiftyOne Enterprise datasets may contain samples whose filepath refers to cloud object storage paths and/or publicly available URLs. .. note:: - :ref:`Click here ` to see how to configure FiftyOne - Teams to load your cloud credentials! + :ref:`Click here ` to see how to configure FiftyOne + Enterprise to load your cloud credentials! -.. _teams-cloud-media-caching: +.. _enterprise-cloud-media-caching: Cloud media caching ___________________ When you work with cloud-backed datasets using the -:ref:`Teams SDK `, media files will automatically be +:ref:`Enterprise SDK `, media files will automatically be downloaded and cached on the machine you’re working from when you execute workflows such as model inference or Brain methods that require access to the pixels of the media files. This design minimizes bandwidth usage and can @@ -32,12 +32,12 @@ file repeatedly: import fiftyone as fo import fiftyone.brain as fob - dataset = fo.load_dataset("a-teams-dataset") + dataset = fo.load_dataset("an-enterprise-dataset") # Automatically downloads cloud media to your local cache for processing fob.compute_visualization(dataset, brain_key="img_viz") -When launching the App locally using the Teams SDK, media will be served from +When launching the App locally using the Enterprise SDK, media will be served from your local cache whenever possible; otherwise it will be automatically retrieved from the cloud: @@ -46,14 +46,14 @@ retrieved from the cloud: import fiftyone as fo - dataset = fo.load_dataset("a-teams-dataset") + dataset = fo.load_dataset("an-enterprise-dataset") # Any media you view will be automatically retrieved from the cloud session = fo.launch_app(dataset) By default, viewing media in the App will not add it to your local media cache, but, if desired, you can enable caching of images via the `cache_app_images` -parameter of your :ref:`media cache config `. Viewing +parameter of your :ref:`media cache config `. Viewing video datasets in the App will never cause previously uncached videos to be cached locally. @@ -70,7 +70,7 @@ cached locally. available when viewing datasets in the App. Otherwise, the App must pull this metadata each time you view a sample. -.. _teams-media-cache-config: +.. _enterprise-media-cache-config: Media cache config __________________ @@ -83,8 +83,8 @@ of virtual CPU cores on your machine to download media files. When the cache is full, local files are automatically deleted in reverse order of when they were last accessed (i.e., oldest deleted first). -You can configure the behavior of FiftyOne Team’s media cache in any of the -following ways. +You can configure the behavior of FiftyOne Enterprise’s media cache in any of +the following ways. 1. Configure your media cache on a per-session basis by setting any of the following environment variables (default values shown): @@ -116,12 +116,12 @@ You can change the location of this file by setting the If you combine multiple options above, environment variables will take precedence over JSON config settings. -.. _teams-cloud-media-python: +.. _enterprise-cloud-media-python: Working with cloud-backed datasets __________________________________ -When writing Python code using the Teams client that may involve cloud-backed +When writing Python code using the Enterprise client that may involve cloud-backed datasets, use `sample.local_path` instead of `sample.filepath` to retrieve the location of the locally cached version of a media file: @@ -130,7 +130,7 @@ the location of the locally cached version of a media file: import fiftyone as fo - dataset = fo.load_dataset("a-teams-dataset") + dataset = fo.load_dataset("an-enterprise-dataset") sample = dataset.first() print(sample.filepath) @@ -142,7 +142,7 @@ the location of the locally cached version of a media file: .. note:: If `sample.filepath` itself is a local path, then `sample.local_path` - will simply return that path. In other words, it is safe to write all Teams + will simply return that path. In other words, it is safe to write all Enterprise Python code as if the dataset contains cloud-backed media. .. note:: @@ -179,7 +179,7 @@ when iterating over samples in a collection: import fiftyone as fo - dataset = fo.load_dataset("a-teams-dataset") + dataset = fo.load_dataset("an-enterprise-dataset") # Download media using the default batching strategy with dataset.download_context(): @@ -195,7 +195,7 @@ when iterating over samples in a collection: You can configure the default size of each download batch via the ``download_size_bytes`` parameter of your - :ref:`media cache config `. + :ref:`media cache config `. Download contexts provide a middle ground between the two extremes: @@ -378,7 +378,7 @@ or you can use `delete_files()` to delete assets: All of the above methods use the media cache's thread pool to maximize throughput. -.. _teams-cloud-api-reference: +.. _enterprise-cloud-api-reference: API reference _____________ @@ -721,7 +721,7 @@ _____________ the list of remote paths """ -.. _teams-annotating-cloud-media: +.. _enterprise-annotating-cloud-media: Annotating cloud-backed datasets with CVAT __________________________________________ @@ -769,7 +769,7 @@ collection being annotated, then you can simply pass `cloud_manifest=True`: The cloud manifest file must contain all media files in the sample collection being annotated. -.. _teams-annotating-cloud-media-v7: +.. _enterprise-annotating-cloud-media-v7: Annotating cloud-backed datasets with V7 Darwin _______________________________________________ @@ -798,7 +798,7 @@ specify the sluggified external storage name: ... ) -.. _teams-annotating-cloud-media-labelbox: +.. _enterprise-annotating-cloud-media-labelbox: Annotating cloud-backed datasets with Labelbox ______________________________________________ @@ -832,24 +832,24 @@ method to pass URLs for your S3-backed media when creating Labelbox data rows. any Google Cloud, Azure, or local media will still be uploaded to Labelbox as usual. -.. _teams-cloud-functions: +.. _enterprise-cloud-functions: AWS Lambda and Google Cloud Functions _____________________________________ -FiftyOne Teams can easily be used in AWS Lambda Functions and Google Cloud +FiftyOne Enterprise can easily be used in AWS Lambda Functions and Google Cloud Functions. **Requirements** -We recommend including Teams in your function’s `requirements.txt` file by -passing your token as a build environment variable, e.g., -`FIFTYONE_TEAMS_TOKEN` and then using the syntax below to specify the version -of the Teams client to use: +We recommend including FiftyOne Enterprise in your function’s `requirements.txt` +file by passing your token as a build environment variable, e.g., +`FIFTYONE_ENTERPRISE_TOKEN` and then using the syntax below to specify the version +of the FiftyOne Enterprise client to use: .. code-block:: text - https://${FIFTYONE_TEAMS_TOKEN}@pypi.fiftyone.ai/packages/fiftyone-0.6.6-py3-none-any.whl + https://${FIFTYONE_ENTERPRISE_TOKEN}@pypi.fiftyone.ai/packages/fiftyone-0.6.6-py3-none-any.whl **Runtime** diff --git a/docs/source/teams/data_lens.rst b/docs/source/enterprise/data_lens.rst similarity index 96% rename from docs/source/teams/data_lens.rst rename to docs/source/enterprise/data_lens.rst index 048cc6811e7..38c0df9c49e 100644 --- a/docs/source/teams/data_lens.rst +++ b/docs/source/enterprise/data_lens.rst @@ -5,9 +5,9 @@ Data Lens .. default-role:: code -**Available in FiftyOne Teams v2.2+** +**Available in FiftyOne Enterprise v2.2+** -Data Lens is a feature built into the :ref:`FiftyOne Teams App ` +Data Lens is a feature built into the :ref:`FiftyOne Enterprise App ` which allows you to use FiftyOne to explore and import samples from external data sources. @@ -17,7 +17,7 @@ Whether your data resides in a database like PostgreSQL or a data lake like data sources, visualize sample data, and import into FiftyOne for further analysis. -.. image:: /images/teams/data_lens_home.png +.. image:: /images/enterprise/data_lens_home.png :alt: data-lens-home-tab :align: center @@ -59,7 +59,7 @@ Once your operator is defined, you can navigate to the "Data sources" tab by clicking on the tab header or by clicking on "Connect to a data source" from the "Home" tab. -.. image:: /images/teams/data_lens_data_sources_empty.png +.. image:: /images/enterprise/data_lens_data_sources_empty.png :alt: data-lens-data-sources-empty :align: center @@ -68,13 +68,13 @@ Add a new data source by clicking on "Add data source". Enter a useful name for your data source and provide the URI for your operator. The URI should have the format `/`. -.. image:: /images/teams/data_lens_add_data_source.png +.. image:: /images/enterprise/data_lens_add_data_source.png :alt: data-lens-add-data-source :align: center Click "Connect" once you're finished to save your configuration. -.. image:: /images/teams/data_lens_data_sources.png +.. image:: /images/enterprise/data_lens_data_sources.png :alt: data-lens-data-sources :align: center @@ -107,7 +107,7 @@ allowing you to tailor your search experience to exactly what you need. Selecting a new data source will automatically update the query parameters to match those expected by your data source. -.. image:: /images/teams/data_lens_query.png +.. image:: /images/enterprise/data_lens_query.png :alt: data-lens-query :align: center @@ -116,7 +116,7 @@ at the bottom of the page to fetch samples which match your query parameters. These samples will be displayed in the preview panel, along with any features associated with the sample like labels or bounding boxes. -.. image:: /images/teams/data_lens_preview.png +.. image:: /images/enterprise/data_lens_preview.png :alt: data-lens-preview :align: center @@ -139,7 +139,7 @@ Importing samples to FiftyOne After generating a preview in Data Lens, you can click on the "Import data" button to open the import dialog. -.. image:: /images/teams/data_lens_import_dialog.png +.. image:: /images/enterprise/data_lens_import_dialog.png :alt: data-lens-import-dialog :align: center @@ -166,7 +166,7 @@ sample. When you click import, you will have the option to either execute immediately or to schedule this import for asynchronous execution. -.. image:: /images/teams/data_lens_import_options.png +.. image:: /images/enterprise/data_lens_import_options.png :alt: data-lens-import-options :align: center @@ -177,7 +177,7 @@ import, as this will result in more consistent and performant execution. .. note:: Scheduled imports use the - :ref:`delegated operations ` framework to + :ref:`delegated operations ` framework to execute asynchronously on your connected compute cluster! After selecting your execution preference, you will be able to monitor the @@ -187,20 +187,20 @@ In the case of immediate execution, you will be presented with an option to view your samples once the import is complete. Clicking on this button will open your destination dataset containing your imported samples. -.. image:: /images/teams/data_lens_immediate_import.png +.. image:: /images/enterprise/data_lens_immediate_import.png :alt: data-lens-immediate-import :align: center In the case of scheduled execution, you will be presented with an option to -visit the :ref:`Runs page `. +visit the :ref:`Runs page `. -.. image:: /images/teams/data_lens_scheduled_import.png +.. image:: /images/enterprise/data_lens_scheduled_import.png :alt: data-lens-scheduled-import :align: center From the Runs page, you can track the status of your import. -.. image:: /images/teams/data_lens_runs_page.png +.. image:: /images/enterprise/data_lens_runs_page.png :alt: data-lens-runs-page :align: center @@ -208,7 +208,7 @@ Once your samples are imported, you will be able to leverage the full capabilities of FiftyOne to analyze and curate your data, and you can continue to use Data Lens to augment your datasets. -.. image:: /images/teams/data_lens_imported_samples.png +.. image:: /images/enterprise/data_lens_imported_samples.png :alt: data-lens-imported-samples :align: center @@ -235,7 +235,7 @@ Setting up your operator To assist with Data Lens integration, we can use the :class:`DataLensOperator ` -base class provided with the Teams SDK. This base class handles the +base class provided with the Enterprise SDK. This base class handles the implementation for the operator's `execute()` method, and defines a single abstract method that we'll implement. @@ -282,7 +282,7 @@ Let's take a look at what we have so far. Our operator extends the :class:`DataLensOperator ` -provided by the Teams SDK. This base class defines the abstract +provided by the Enterprise SDK. This base class defines the abstract :meth:`handle_lens_search_request() ` method, which we will need to implement. @@ -351,7 +351,7 @@ the following properties: The `ctx` argument provides access to a :ref:`range of useful capabilities ` which you can leverage in your operator, including things like -:ref:`providing secrets to your operator `. +:ref:`providing secrets to your operator `. Using these inputs, we are expected to return a generator which yields :class:`DataLensSearchResponse ` @@ -423,7 +423,7 @@ tab to interact with the operator. When we click the preview button, the Data Lens framework invokes our operator to retrieve sample data. Our operator yields a single sample, and we see that sample shown in the preview. -.. image:: /images/teams/data_lens_synthetic_sample.png +.. image:: /images/enterprise/data_lens_synthetic_sample.png :alt: data-lens-synthetic-sample :align: center @@ -458,7 +458,7 @@ Let's modify our operator to incorporate the `request.batch_size` property. Now if we re-run our preview, we see that we get a number of samples equal to the "Number of preview samples" input. -.. image:: /images/teams/data_lens_synthetic_batch.png +.. image:: /images/enterprise/data_lens_synthetic_batch.png :alt: data-lens-synthetic-batch :align: center @@ -502,7 +502,7 @@ method. With this method implemented, Data Lens will construct a form allowing users to define any or all of these inputs. -.. image:: /images/teams/data_lens_synthetic_query.png +.. image:: /images/enterprise/data_lens_synthetic_query.png :alt: data-lens-synthetic-query :align: center @@ -554,7 +554,7 @@ Now when we run our preview, we can see that the text we provide as input is reflected in the samples returned by our operator. Modifying the text and regenerating the preview yields the expected result. -.. image:: /images/teams/data_lens_synthetic_text.png +.. image:: /images/enterprise/data_lens_synthetic_text.png :alt: data-lens-synthetic-text :align: center @@ -1072,7 +1072,7 @@ Let's take a look at a few parts in detail. # Create our client client = bigquery.Client() -In practice, you'll likely need to use :ref:`secrets ` to +In practice, you'll likely need to use :ref:`secrets ` to securely provide credentials to connect to your data source. .. code-block:: python diff --git a/docs/source/teams/data_quality.rst b/docs/source/enterprise/data_quality.rst similarity index 87% rename from docs/source/teams/data_quality.rst rename to docs/source/enterprise/data_quality.rst index 3456c323a19..22afb2e9bd3 100644 --- a/docs/source/teams/data_quality.rst +++ b/docs/source/enterprise/data_quality.rst @@ -5,10 +5,10 @@ Data Quality .. default-role:: code -**Available in FiftyOne Teams v2.2+** +**Available in FiftyOne Enterprise v2.2+** The Data Quality panel is a builtin feature of the -:ref:`FiftyOne Teams App ` that automatically scans your dataset +:ref:`FiftyOne Enterprise App ` that automatically scans your dataset for common quality issues and helps you explore and take action to resolve them. @@ -34,7 +34,7 @@ current analysis/review status: Click on the right arrow of an issue type's card to open its expanded view. -.. image:: /images/teams/data_quality_home.png +.. image:: /images/enterprise/data_quality_home.png :alt: data-quality-home :align: center @@ -46,13 +46,13 @@ ___________________ If you have not yet scanned a dataset for a given issue type, you'll see a landing page like this: -.. image:: /images/teams/data_quality_brightness_scan.png +.. image:: /images/enterprise/data_quality_brightness_scan.png :alt: data-quality-brightness-scan :align: center Clicking the "Scan Dataset" button presents two choices for execution: -.. image:: /images/teams/data_quality_brightness_scan_options.png +.. image:: /images/enterprise/data_quality_brightness_scan_options.png :alt: data-quality-brightness-scan-options :align: center @@ -63,17 +63,17 @@ Clicking the "Scan Dataset" button presents two choices for execution: few minutes. Choose "Schedule" for all production data, which schedules the scan for - :ref:`delegated execution ` on your compute + :ref:`delegated execution ` on your compute cluster. While a scan is in-progress, you'll see a status page like this: -.. image:: /images/teams/data_quality_brightness_scheduled.png +.. image:: /images/enterprise/data_quality_brightness_scheduled.png :alt: data-quality-brightness-scheduled :align: center Click the link in the notification to navigate to the dataset's -:ref:`Runs page ` where you can monitor +:ref:`Runs page ` where you can monitor the status of the task. .. _data-quality-analyze: @@ -84,7 +84,7 @@ ______________________ Once an issue scan is complete, its card will update to display an interactive histogram that you can use to analyze the findings: -.. image:: /images/teams/data_quality_brightness_analysis.png +.. image:: /images/enterprise/data_quality_brightness_analysis.png :alt: data-quality-brightness-analysis :align: center @@ -120,7 +120,7 @@ You can also use the threshold slider to manually explore different threshold ranges. When you release the slider, the Samples panel will automatically update to show the corresponding samples: -.. image:: /images/teams/data_quality_brightness_slider.gif +.. image:: /images/enterprise/data_quality_brightness_slider.gif :alt: data-quality-brightness-slider :align: center @@ -132,7 +132,7 @@ Once you've reviewed the potential issues in the grid, you can use the "Add Tags" button to take action on them. Clicking the button will display a modal like this: -.. image:: /images/teams/data_quality_brightness_tag.png +.. image:: /images/enterprise/data_quality_brightness_tag.png :alt: data-quality-brightness-tag :align: center @@ -154,7 +154,7 @@ If you navigate away from an issue type that is currently "In Review", you'll be prompted to indicate whether or not you'd like to mark the issue type as "Reviewed": -.. image:: /images/teams/data_quality_brightness_mark_as_reviewed.png +.. image:: /images/enterprise/data_quality_brightness_mark_as_reviewed.png :alt: data-quality-brightness-mark-as-reviewed :align: center @@ -176,7 +176,7 @@ the panel will automatically detect the presence of unscanned samples and will display contextual information from the :ref:`home page ` and :ref:`analysis page `: -.. image:: /images/teams/data_quality_new_samples_home.png +.. image:: /images/enterprise/data_quality_new_samples_home.png :alt: data-quality-new-samples-home :align: center @@ -185,7 +185,7 @@ To update an existing scan, open the issue type and click the :ref:`analysis page `. This will open a modal that provides additional context and prompts you to initiate the new samples scan: -.. image:: /images/teams/data_quality_new_samples_modal.png +.. image:: /images/enterprise/data_quality_new_samples_modal.png :alt: data-quality-new-samples-modal :align: center diff --git a/docs/source/teams/dataset_versioning.rst b/docs/source/enterprise/dataset_versioning.rst similarity index 94% rename from docs/source/teams/dataset_versioning.rst rename to docs/source/enterprise/dataset_versioning.rst index 68ff457ffec..98e960a25ac 100644 --- a/docs/source/teams/dataset_versioning.rst +++ b/docs/source/enterprise/dataset_versioning.rst @@ -5,7 +5,7 @@ Dataset Versioning .. default-role:: code -FiftyOne Teams provides native support for versioning your datasets! +FiftyOne Enterprise provides native support for versioning your datasets! Dataset Versioning allows you to capture the state of your dataset in time so that it can be referenced in the future. This enables workflows like recalling @@ -24,7 +24,7 @@ annotation added, etc) as well as helping to prevent accidental data loss. Overview ________ -Dataset Versioning in FiftyOne Teams is implemented as a linear sequence of +Dataset Versioning in FiftyOne Enterprise is implemented as a linear sequence of read-only :ref:`Snapshots `. In other words, creating a new Snapshot creates a permanent record of the dataset’s contents that can be loaded and viewed at any time in the future, but not directly @@ -78,7 +78,7 @@ Dataset Versioning has been built with an extensible architecture so that different versioning backends can be swapped in. Each backend may have different tradeoffs in terms of performance, storage, and deployment needs, so users should be able to choose the best fit for their needs. In addition, many -users may already have a versioning solution external to FiftyOne Teams, and +users may already have a versioning solution external to FiftyOne Enterprise, and the goal is to support integration around those use cases as well. Currently, only the @@ -97,7 +97,7 @@ are :ref:`on the roadmap `. Snapshots _________ -Dataset Versioning in FiftyOne Teams is implemented as a linear history of +Dataset Versioning in FiftyOne Enterprise is implemented as a linear history of **Snapshots**. A Snapshot captures the state of a dataset at a particular point in time as an immutable object. Compare this concept to creating commits and tags in a single branch of a version control system such as git or svn; a @@ -133,7 +133,7 @@ choices and user actions. Virtual Snapshot A Snapshot whose state and contents are stored by the pluggable backend versioning implementation in whatever way it chooses. In order to be - loaded by FiftyOne Teams users, the Snapshot must be *materialized* + loaded by FiftyOne Enterprise users, the Snapshot must be *materialized* into its workable form in MongoDB. This is done through a combination of the overarching versioning infrastructure and the specific versioning backend. @@ -165,7 +165,7 @@ creating snapshots causes database storage to grow quickly! When a snapshot is archived, all of its contents are stored in an archive in the configured cold storage location: either a mounted filesystem or cloud storage folder (using your deployment's -:ref:`cloud credentials `). +:ref:`cloud credentials `). .. note:: @@ -237,7 +237,7 @@ Usage notes Snapshot permissions ____________________ -The table below shows the :ref:`dataset permissions ` +The table below shows the :ref:`dataset permissions ` required to perform different Snapshot-related operations: +----------------------------+----------------------------------+ @@ -278,20 +278,20 @@ trigger a modification to the stored dataset. List snapshots -------------- -Teams UI -~~~~~~~~ +Enterprise UI +~~~~~~~~~~~~~ To access the Snapshot history and management page, click the "History tab" on a dataset's main page. -.. image:: /images/teams/versioning/history-tab-button.png +.. image:: /images/enterprise/versioning/history-tab-button.png :alt: history-tab-button :align: center On this page you can see a listing of the Snapshot history for the dataset. Each row contains information about a single Snapshot. -.. image:: /images/teams/versioning/snapshot-list.png +.. image:: /images/enterprise/versioning/snapshot-list.png :alt: snapshot-list :align: center @@ -330,16 +330,16 @@ Loading snapshots ----------------- Any user with Can View permissions to a dataset can view and load its snapshots -via the Teams UI or the SDK. +via the Enterprise UI or the SDK. -Teams UI -~~~~~~~~ +Enterprise UI +~~~~~~~~~~~~~ From the dataset's History tab, click the "Browse" button next to a Snapshot in the :ref:`snapshot list ` to load the Snapshot in the UI. -.. image:: /images/teams/versioning/browse-button.png +.. image:: /images/enterprise/versioning/browse-button.png :alt: history-browse-button :align: center @@ -353,7 +353,7 @@ button. For the above Snapshot, it would look like this: .. code-block:: text - https:///datasets/roadscene-vehicle-detection/samples?snapshot=new+snapshot + https:///datasets/roadscene-vehicle-detection/samples?snapshot=new+snapshot One other difference from the normal page is the Snapshot banner which gives information about the Snapshot being viewed, and other quick-click operations. @@ -361,7 +361,7 @@ Clicking the name line drops down a list of the Snapshots where the current one is highlighted. Clicking on a Snapshot in the dropdown will navigate to the browse page for that Snapshot. -.. image:: /images/teams/versioning/browse-banner-dropdown.png +.. image:: /images/enterprise/versioning/browse-banner-dropdown.png :alt: browse-banner-dropdown :align: center @@ -372,7 +372,7 @@ from the 3-dot (kebab) menu which gives various :ref:`management functions ` for the current Snapshot. -.. image:: /images/teams/versioning/browse-banner-right.png +.. image:: /images/enterprise/versioning/browse-banner-right.png :alt: browse-banner-rightside :align: center @@ -409,14 +409,14 @@ Creating a snapshot ------------------- Users with Can Manage permissions to a dataset can create Snapshots through the -Teams UI or the Management SDK. +Enterprise UI or the Management SDK. .. note:: Snapshots can only be created from the HEAD of the dataset. -Teams UI -~~~~~~~~ +Enterprise UI +~~~~~~~~~~~~~ At the top of the History tab for a dataset is the Create snapshot panel. This panel shows the number of changes that have happened between the last @@ -427,7 +427,7 @@ Snapshot and the current state of the dataset. The latest changes summary is not continuously updated; click the "Refresh" button to recompute these values. -.. image:: /images/teams/versioning/create-refresh-button.png +.. image:: /images/enterprise/versioning/create-refresh-button.png :alt: create-refresh-button :align: center @@ -440,13 +440,13 @@ click the "Save new snapshot" button. used, deployment options chosen, and the size of the dataset, this may take some time. -.. image:: /images/teams/versioning/create-save-button.png +.. image:: /images/enterprise/versioning/create-save-button.png :alt: create-save-button :align: center After creation, the new Snapshot will show up in the list! -.. image:: /images/teams/versioning/history-new-snapshot.png +.. image:: /images/enterprise/versioning/history-new-snapshot.png :alt: history-new-snapshot :align: center @@ -505,7 +505,7 @@ Deleting a snapshot ------------------- Users with Can Manage permissions to a dataset can delete snapshots through the -Teams UI or the Management SDK. +Enterprise UI or the Management SDK. If the Snapshot is the most recent, the latest (HEAD) sample changes summary is not automatically recalculated. See @@ -520,14 +520,14 @@ Snapshot. Deleting a Snapshot cannot be undone! -Teams UI -~~~~~~~~ +Enterprise UI +~~~~~~~~~~~~~ To delete a Snapshot via the App, open the 3-dot (kebab) menu for the Snapshot. In the menu, click "Delete snapshot". This will bring up a confirmation dialog to prevent accidental deletions. -.. image:: /images/teams/versioning/delete-snapshot.png +.. image:: /images/enterprise/versioning/delete-snapshot.png :alt: delete-snapshot :align: center @@ -562,15 +562,15 @@ of a given Snapshot. **all** changes between the selected Snapshot and the current working version of the dataset, including all newer Snapshots. -Teams UI -~~~~~~~~ +Enterprise UI +~~~~~~~~~~~~~ To revert a dataset to a Snapshot's state, click the 3-dot (kebab) menu in the History tab for the Snapshot you want to rollback to and select "Rollback to this snapshot". This will bring up a confirmation dialog to prevent accidental deletions. -.. image:: /images/teams/versioning/rollback-snapshot.png +.. image:: /images/enterprise/versioning/rollback-snapshot.png :alt: rollback-snapshot :align: center @@ -615,15 +615,15 @@ configured cold storage location via the UI or the Management SDK. The snapshot must first be :ref:`unarchived `. -Teams UI -~~~~~~~~ +Enterprise UI +~~~~~~~~~~~~~ To manually archive a snapshot, click the 3-dot (kebab) menu in the History tab for a snapshot you want to archive and select "Archive snapshot". This will begin the archival process and the browse button will be replaced with an "Archiving" spinner": -.. image:: /images/teams/versioning/archive-snapshot.png +.. image:: /images/enterprise/versioning/archive-snapshot.png :alt: archive-snapshot :align: center @@ -655,14 +655,14 @@ Unarchive snapshot To make an archived snapshot browsable again, users with Can Manage permissions to the dataset can unarchive it via the UI or Management SDK. -Teams UI -~~~~~~~~ +Enterprise UI +~~~~~~~~~~~~~ To unarchive a snapshot, click the "Unarchive" button in the History tab for a snapshot you want to unarchive. This will begin the unarchival process and the archive button will be replaced with an "Unarchiving" spinner: -.. image:: /images/teams/versioning/unarchive-snapshot.png +.. image:: /images/enterprise/versioning/unarchive-snapshot.png :alt: unarchive-snapshot :align: center @@ -701,7 +701,7 @@ better suit the users' needs and technology preferences. In the future, this section will contain information and discussion about each of these available backends, including their strengths/limitations and configuration options. -For the initial release in FiftyOne Teams v1.4.0, however, there is only one +For the initial release in FiftyOne Enterprise v1.4.0, however, there is only one backend choice described below. Additional backends may be implemented in the future, but for now, releasing dataset versioning with the first iteration was prioritized so that users can begin to see value and provide @@ -808,7 +808,7 @@ following advice: Configuration ------------- -Since Snapshots impact the storage needs of FiftyOne Teams, some guard rails +Since Snapshots impact the storage needs of FiftyOne Enterprise, some guard rails have been put in place to control the maximum amount of Snapshots that can be created. If a threshold has been exceeded while a user attempts to create a new Snapshot, they will receive an error informing them that it may be time to @@ -844,7 +844,7 @@ Roadmap _______ The following are some items that are on the roadmap for future iterations -of the dataset versioning system. Keep an eye out for future FiftyOne Teams +of the dataset versioning system. Keep an eye out for future FiftyOne Enterprise versions for these additional features! **Near term** diff --git a/docs/source/teams/index.rst b/docs/source/enterprise/index.rst similarity index 73% rename from docs/source/teams/index.rst rename to docs/source/enterprise/index.rst index 0a69fc62151..84fd2ed2193 100644 --- a/docs/source/teams/index.rst +++ b/docs/source/enterprise/index.rst @@ -1,7 +1,7 @@ -.. _fiftyone-teams: +.. _fiftyone-enterprise: -FiftyOne Teams -============== +FiftyOne Enterprise +=================== .. Social links --------------------------------------------------------------- @@ -10,13 +10,13 @@ FiftyOne Teams