FiftyOne Teams Installation¶

FiftyOne Teams deployments come with a centralized FiftyOne Teams App and database that allows your entire team to collaborate securely on the same datasets. FiftyOne Teams is deployed entirely into your environment, either on-premises or in a private cloud. Your data never leaves your environment.

FiftyOne Teams can be deployed on a wide variety of infrastructure solutions, including Kubernetes and Docker.

Note

Detailed instructions for the initial FiftyOne Teams deployment, along with all necessary components, are made available by your Voxel51 CS engineer during the onboarding process.

This page focuses on SDK installation for technical users that wish to interact with their team’s dataests via Python.

Python SDK¶

While the FiftyOne Teams App allows for countless new App-centric workflows, any existing Python-based workflows that you’ve fallen in love with in the open-source version of FiftyOne are still directly applicable!

FiftyOne Teams requires an updated Python SDK, which is a wrapper around the open-source FiftyOne package that adds new functionality like support for cloud-backed media.

You can find the installation instructions under the “Install FiftyOne” section of the Teams App by clicking on your user icon in the upper right corner:

There you’ll see instructions for installing a fiftyone package from the private PyPI server as shown below:

pip install --index-url https://{$TOKEN}@pypi.fiftyone.ai fiftyone

Note

The Teams Python package is named fiftyone and has the same module structure as fiftyone, so any existing scripts you built using open source will continue to run after you upgrade!

Next Steps

After installing the Teams Python SDK in your virtual environment, you’ll need to configure two things:

The connection to your team’s centralized database
The cloud credentials to access your cloud-backed media

That’s it! Any operations you perform will be stored on thecentralized database and will be available to all users with access to the same datasets in the Teams App or their Python workflows.

Note

Ask your FiftyOne Teams admin for the necessary MongoDB connection URI and relevant cloud credentials.

Cloud credentials¶

Amazon S3¶

To work with FiftyOne datasets whose media are stored in Amazon S3, you simply need to provide AWS credentials to your Teams client with read access to the relevant files.

You can do this in any of the following ways:

1. Configure/provide AWS credentials in accordance with the boto3 python library.

2. Permanently register AWS credentials on a particular machine by adding the following keys to your media cache config:

{
    "aws_config_file": "/path/to/aws-config.ini",
    "aws_profile": "default"  # optional
}

In the above, the .ini file should use the syntax of the boto3 configuration file.

Google Cloud Storage¶

To work with FiftyOne datasets whose media are stored in Google Cloud Storage, you simply need to provide service account credentials to your Teams client with read access to the relevant files.

You can register GCP credentials on a particular machine by adding the following key to your media cache config:

{
    "google_application_credentials": "/path/to/gcp-service-account.json"
}

MinIO¶

To work with FiftyOne datasets whose media are stored in MinIO, you simply need to provide the credentials to your Teams client with read access to the relevant files.

You can do this in any of the following ways:

1. Permanently register MinIO credentials on a particular machine by adding the following keys to your media cache config:

{
    "minio_config_file": "/path/to/minio-config.ini",
    "minio_profile": "default"  # optional
}

2. Provide MinIO credentials on a per-session basis by setting the following environment variables to point to your MinIO credentials:

export MINIO_CONFIG_FILE=/path/to/minio-config.ini
export MINIO_PROFILE=default  # optional

3. Provide your MinIO credentials on a per-session basis by setting the individual environment variables shown below:

export MINIO_ACCESS_KEY=...
export MINIO_SECRET_ACCESS_KEY=...
export MINIO_ENDPOINT_URL=...
export MINIO_ALIAS=...  # optional
export MINIO_REGION=...  # if applicable

If you combine multiple options above, environment variables will take precedence over JSON config settings.

In the options above, the .ini file should have syntax similar the following:

[default]
access_key = ...
secret_access_key = ...
endpoint_url = ...
alias = ...  # optional
region = ...  # if applicable

When populating samples with MinIO filepaths, you can either specify paths by prefixing your MinIO endpoint URL:

filepath = "${endpoint_url}/bucket/path/to/object.ext"

# For example
filepath = "https://voxel51.min.io/test-bucket/image.jpg"

or, if you have defined an alias in your config, you may instead prefix the alias:

filepath = "${alias}://bucket/path/to/object.ext"

# For example
filepath = "minio://test-bucket/image.jpg"