Cloud-Backed Media ¶

FiftyOne Teams datasets may contain samples whose filepath refers to cloud object storage paths and/or publicly available URLs.

Note

Click here to see how to configure FiftyOne Teams to load your cloud credentials!

Cloud media caching ¶

When you work with cloud-backed datasets using the Teams 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 significantly improve performance in workflows where you access the same media file repeatedly:

import fiftyone as fo
import fiftyone.brain as fob

dataset = fo.load_dataset("a-teams-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 your local cache whenever possible; otherwise it will be automatically retrieved from the cloud:

import fiftyone as fo

dataset = fo.load_dataset("a-teams-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 media cache config. Viewing video datasets in the App will never cause previously uncached videos to be cached locally.

Note

We recommend that you populate the metadata on your datasets at creation time:

dataset.compute_metadata()

so that the dimensions of all media stored in the cloud are readily available when viewing datasets in the App. Otherwise, the App must pull this metadata each time you view a sample.

Media cache config ¶

By default, your local media cache is located at ~/fiftyone/__cache__, has a size of 32GB, will download media in batches of 128MB when using download_context(), and will use a thread pool whose size equals the number 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.

1. Configure your media cache on a per-session basis by setting any of the following environment variables (default values shown):

export FIFTYONE_MEDIA_CACHE_DIR=/path/for/media-cache
export FIFTYONE_MEDIA_CACHE_SIZE_BYTES=34359738368  # 32GB
export FIFTYONE_MEDIA_CACHE_DOWNLOAD_SIZE_BYTES=134217728  # 128MB
export FIFTYONE_MEDIA_CACHE_NUM_WORKERS=16
export FIFTYONE_MEDIA_CACHE_APP_IMAGES=false

2. Create a media cache config file at ~/.fiftyone/media_cache_config.json that contains any of the following keys (default values shown):

{
    "cache_dir": "/path/for/media-cache",
    "cache_size_bytes": 34359738368,
    "download_size_bytes": 134217728,
    "num_workers": 16,
    "cache_app_images": false
}

You can change the location of this file by setting the FIFTYONE_MEDIA_CACHE_CONFIG_PATH environment variable.

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

Working with cloud-backed datasets ¶

When writing Python code using the Teams 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:

import fiftyone as fo

dataset = fo.load_dataset("a-teams-dataset")
sample = dataset.first()

print(sample.filepath)
# ex: s3://voxel51-test/images/000001.jpg

print(sample.local_path)
# ex: ~/fiftyone/__cache__/media/s3/voxel51-test/images/000001.jpg

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 Python code as if the dataset contains cloud-backed media.

Note

If you access sample.local_path and the corresponding media file is not cached locally, it will immediately be downloaded.

You can use download_media() to efficiently download and cache the source media files for an entire dataset or view using the cache’s full thread pool to maximize throughput:

import fiftyone as fo

# Download media for a view
view = dataset.shuffle().limit(10)
view.download_media()

# Download all media in the dataset
dataset.download_media()

Note

By default, download_media() will automatically skip any already cached media.

You can also use download_context() to download smaller batches of media when iterating over samples in a collection:

import fiftyone as fo

dataset = fo.load_dataset("a-teams-dataset")

# Download media using the default batching strategy
with dataset.download_context():
    for sample in dataset:
        sample.local_path  # already downloaded

# Download media in batches of 50MB
with dataset.download_context(target_size_bytes=50 * 1024**2):
    for sample in dataset:
        sample.local_path  # already downloaded

Note

You can configure the default size of each download batch via the download_size_bytes parameter of your media cache config.

Download contexts provide a middle ground between the two extremes:

# Download all media in advance
dataset.download_media()
for sample in dataset:
    sample.local_path  # already downloaded

# Download individual images just in time
for sample in dataset:
    sample.local_path   # downloads media now

Note

Download contexts are useful if your cache is not large enough to store all the media in the dataset you’re working with simultaneously.

You can also use get_local_paths() to retrieve the list of local paths for each sample in a potentially cloud-backed dataset or view:

# These methods support full datasets or views into them
sample_collection = dataset
# sample_collection = dataset.limit(10)

# Retrieve the local paths for all media in a collection
local_paths = sample_collection.get_local_paths()

print(local_paths[0])
# ex: ~/fiftyone/__cache__/media/s3/voxel51-test/images/000001.jpg

# Retrieve the possibly-cloud paths for all media in a collection
cloud_paths = sample_collection.values("filepath")

print(cloud_paths[0])
# ex: s3://voxel51-test/images/000001.jpg

You can get information about currently cached media files for a sample collection by calling cache_stats():

# View cache stats for the current collection
sample_collection.cache_stats()

{'cache_dir': '~/fiftyone/__cache__',
 'cache_size': 34359738368,
 'cache_size_str': '32.0GB',
 'current_size': 24412374,
 'current_size_str': '23.3MB',
 'current_count': 200,
 'load_factor': 0.000710493593942374}

and you can call clear_media() to delete any cached copies of media in the collection:

# Clear this collection's media from the cache
sample_collection.clear_media()

You can also perform these operations on the full cache as follows:

# View global cache stats
print(fo.media_cache.stats())

{'cache_dir': '~/fiftyone/__cache__',
 'cache_size': 34359738368,
 'cache_size_str': '32.0GB',
 'current_size': 49097587,
 'current_size_str': '46.8MB',
 'current_count': 600,
 'load_factor': 0.0014289278478827327}

# Clear the entire cache
fo.media_cache.clear()

The fiftyone.core.storage module also provides a number of convenient methods that can be used to manipulate cloud and/or local media.

The upload_media() method provides a convenient wrapper for uploading a local dataset’s media to the cloud:

import fiftyone.core.storage as fos

# Create a dataset from media stored locally
dataset = fo.Dataset.from_dir("/tmp/local", ...)

# Upload the dataset's media to the cloud
fos.upload_media(
    dataset,
    "s3://voxel51-test/your-media",
    update_filepaths=True,
    progress=True,
)

The fiftyone.core.storage module also provides a number of lower-level methods that you can use to work with cloud and local assets.

import fiftyone.core.storage as fos

s3_paths = [\
    "s3://voxel51-test/images/000001.jpg",\
    "s3://voxel51-test/images/000002.jpg",\
    ...\
]

gcs_paths = [\
    "gs://voxel51-test/images/000001.jpg",\
    "gs://voxel51-test/images/000002.jpg",\
    ...\
\
]

local_paths = [\
    "/tmp/voxel51-test/images/000001.jpg",\
    "/tmp/voxel51-test/images/000002.jpg",\
    ...\
]

For example, you can use list_files() to list the contents of a folder:

cloud_paths = fos.list_files(
    "s3://voxel51-test", abs_paths=True, recursive=True
)

print(cloud_paths)[0]
# ex: s3://voxel51-test/images/000001.jpg

or you can use copy_files() and move_files() to transfer files between destinations:

# S3 -> local
fos.copy_files(s3_paths, local_paths)
fos.move_files(s3_paths, local_paths)

# local -> S3
fos.copy_files(local_paths, s3_paths)
fos.move_files(local_paths, s3_paths)

# S3 -> GCS
fos.copy_files(s3_paths, gcs_paths)
fos.move_files(s3_paths, gcs_paths)

or you can use delete_files() to delete assets:

fos.delete_files(s3_paths)
fos.delete_files(gcs_paths)
fos.delete_files(local_paths)

Note

All of the above methods use the media cache’s thread pool to maximize throughput.

API reference ¶

Dataset methods ¶

import fiftyone as fo

fo.Dataset.download_media?
fo.Dataset.download_scenes?
fo.Dataset.download_context?
fo.Dataset.get_local_paths?
fo.Dataset.cache_stats?
fo.Dataset.clear_media?

fo.Dataset.download_media(
    self,
    media_fields=None,
    group_slices=None,
    include_assets=True,
    update=False,
    skip_failures=True,
    progress=None,
):
    """Downloads the source media files for all samples in the collection.

    This method is only useful for collections that contain remote media.

    Any existing files are not re-downloaded, unless ``update == True`` and
    their checksums no longer match.

    Args:
        media_fields (None): a field or iterable of fields containing media
            to download. By default, all media fields in the collection's
            :meth:`app_config` are used
        group_slices (None): an optional subset of group slices for which
            to download media. Only applicable when the collection contains
            groups
        include_assets (True): whether to include 3D scene assets
        update (False): whether to re-download media whose checksums no
            longer match
        skip_failures (True): whether to gracefully continue without
            raising an error if a remote file cannot be downloaded
        progress (None): whether to render a progress bar tracking the
            progress of any downloads (True/False), use the default value
            ``fiftyone.config.show_progress_bars`` (None), or a progress
            callback function to invoke instead
    """

fo.Dataset.download_scenes(
    self,
    update=False,
    skip_failures=True,
    progress=None,
):
    """Downloads all ``.fo3d`` files for the samples in the collection.

    This method is only useful for collections that contain remote media.

    Any existing files are not re-downloaded, unless ``update == True`` and
    their checksums no longer match.

    Args:
        update (False): whether to re-download files whose checksums no
            longer match
        skip_failures (True): whether to gracefully continue without
            raising an error if a remote file cannot be downloaded
        progress (None): whether to render a progress bar tracking the
            progress of any downloads (True/False), use the default value
            ``fiftyone.config.show_progress_bars`` (None), or a progress
            callback function to invoke instead
    """

fo.Dataset.download_context(
    self,
    batch_size=None,
    target_size_bytes=None,
    media_fields=None,
    group_slices=None,
    include_assets=True,
    update=False,
    skip_failures=True,
    clear=False,
    progress=None,
):
    """Returns a context that can be used to pre-download media in batches
    when iterating over samples in this collection.

    This method is only useful for collections that contain remote media.

    By default, all media will be downloaded when the context is entered,
    but you can configure a batching strategy via the `batch_size` or
    `target_size_bytes` parameters.

    If no ``batch_size`` or ``target_size_bytes`` is provided, media are
    downloaded in batches of ``fo.media_cache_config.download_size_bytes``.

    Args:
        batch_size (None): a sample batch size to use for each download
        target_size_bytes (None): a target content size, in bytes, for each
            download batch. If negative, all media is downloaded in one
            batch
        media_fields (None): a field or iterable of fields containing media
            to download. By default, all media fields in the collection's
            :meth:`app_config` are used
        group_slices (None): an optional subset of group slices to download
            media for. Only applicable when the collection contains groups
        include_assets (True): whether to include 3D scene assets
        update (False): whether to re-download media whose checksums no
            longer match
        skip_failures (True): whether to gracefully continue without
            raising an error if a remote file cannot be downloaded
        clear (False): whether to clear the media from the cache when the
            context exits
        progress (None): whether to render a progress bar tracking the
            progress of any downloads (True/False), use the default value
            ``fiftyone.config.show_progress_bars`` (None), or a progress
            callback function to invoke instead
        **kwargs: valid keyword arguments for :meth:`download_media`

    Returns:
        a :class:`DownloadContext`
    """

fo.Dataset.get_local_paths(
    self,
    media_field="filepath",
    include_assets=True,
    download=True,
    skip_failures=True,
    progress=None,
):
    """Returns a list of local paths to the media files in this collection.

    This method is only useful for collections that contain remote media.

    Args:
        media_field ("filepath"): the field containing the media paths
        include_assets (True): whether to include 3D scene assets
        download (True): whether to download any non-cached media files
        skip_failures (True): whether to gracefully continue without
            raising an error if a remote file cannot be downloaded
        progress (None): whether to render a progress bar tracking the
            progress of any downloads (True/False), use the default value
            ``fiftyone.config.show_progress_bars`` (None), or a progress
            callback function to invoke instead

    Returns:
        a list of local filepaths
    """

fo.Dataset.cache_stats(
    self,
    media_fields=None,
    group_slices=None,
    include_assets=True,
):
    """Returns a dictionary of stats about the cached media files in this
    collection.

    This method is only useful for collections that contain remote media.

    Args:
        media_fields (None): a field or iterable of fields containing media
            paths. By default, all media fields in the collection's
            :meth:`app_config` are included
        group_slices (None): an optional subset of group slices to include.
            Only applicable when the collection contains groups
        include_assets (True): whether to include 3D scene assets

    Returns:
        a stats dict
    """

fo.Dataset.clear_media(
    self,
    media_fields=None,
    group_slices=None,
    include_assets=True,
):
    """Deletes any local copies of media files in this collection from the
    media cache.

    This method is only useful for collections that contain remote media.

    Args:
        media_fields (None): a field or iterable of fields containing media
            paths to clear from the cache. By default, all media fields
            in the collection's :meth:`app_config` are cleared
        group_slices (None): an optional subset of group slices for which
            to clear media. Only applicable when the collection contains
            groups
        include_assets (True): whether to include 3D scene assets
    """

fiftyone.core.storage ¶

import fiftyone.core.storage as fos

fos.list_files?
fos.copy_files?
fos.move_files?
fos.delete_files?
fos.upload_media?

fos.list_files(
    dirpath,
    abs_paths=False,
    recursive=False,
    include_hidden_files=False,
    sort=True,
):
    """Lists the files in the given directory.

    If the directory does not exist, an empty list is returned.

    Args:
        dirpath: the path to the directory to list
        abs_paths (False): whether to return the absolute paths to the files
        recursive (False): whether to recursively traverse subdirectories
        include_hidden_files (False): whether to include dot files
        sort (True): whether to sort the list of files

    Returns:
        a list of filepaths
    """

fos.copy_files(inpaths, outpaths, skip_failures=False, progress=None):
    """Copies the files to the given locations.

    Args:
        inpaths: a list of input paths
        outpaths: a list of output paths
        skip_failures (False): whether to gracefully continue without
            raising an error if a remote operation fails
        progress (None): whether to render a progress bar (True/False), use the
            default value ``fiftyone.config.show_progress_bars`` (None), or a
            progress callback function to invoke instead
    """

fos.move_files(inpaths, outpaths, skip_failures=False, progress=None):
    """Moves the files to the given locations.

    Args:
        inpaths: a list of input paths
        outpaths: a list of output paths
        skip_failures (False): whether to gracefully continue without raising
            an error if a remote operation fails
        progress (None): whether to render a progress bar (True/False), use the
            default value ``fiftyone.config.show_progress_bars`` (None), or a
            progress callback function to invoke instead
    """

fos.delete_files(paths, skip_failures=False, progress=None):
    """Deletes the files from the given locations.

    For local paths, any empty directories are also recursively deleted from
    the resulting directory tree.

    Args:
        paths: a list of paths
        skip_failures (False): whether to gracefully continue without raising
            an error if a remote operation fails
        progress (None): whether to render a progress bar (True/False), use the
            default value ``fiftyone.config.show_progress_bars`` (None), or a
            progress callback function to invoke instead
    """

fos.upload_media(
    sample_collection,
    remote_dir,
    rel_dir=None,
    media_field="filepath",
    update_filepaths=False,
    cache=False,
    overwrite=False,
    skip_failures=False,
    progress=None,
):
    """Uploads the source media files for the given collection to the given
    remote directory.

    Providing a ``rel_dir`` enables writing nested subfolders within
    ``remote_dir`` matching the structure of the input collection's media. By
    default, the files are written directly to ``remote_dir`` using their
    basenames.

    Args:
        sample_collection: a
            :class:`fiftyone.core.collections.SampleCollection`
        remote_dir: a remote "folder" into which to upload
        rel_dir (None): an optional relative directory to strip from each
            filepath when constructing the corresponding remote path
        media_field ("filepath"): the field containing the media paths
        update_filepaths (False): whether to update the ``media_field`` of each
            sample in the collection to its remote path
        cache (False): whether to store the uploaded media in your local media
            cache. The supported values are:

            -   ``False`` (default): do not cache the media
            -   ``True`` or ``"copy"``: copy the media into your local cache
            -   ``"move"``: move the media into your local cache
        overwrite (False): whether to overwrite (True) or skip (False) existing
            remote files
        skip_failures (False): whether to gracefully continue without raising
            an error if a remote operation fails
        progress (None): whether to render a progress bar (True/False), use the
            default value ``fiftyone.config.show_progress_bars`` (None), or a
            progress callback function to invoke instead

    Returns:
        the list of remote paths
    """

Annotating cloud-backed datasets with CVAT ¶

When using FiftyOne to annotate data with CVAT, you can optionally follow the instructions below to instruct CVAT to load media directly from S3, GCS, or MinIO buckets rather than the default behavior of uploading copies of the media to the CVAT server.

First, follow these instructions to attach a cloud storage bucket to CVAT. Then, simply provide the cloud_manifest parameter to annotate() to specify the URL of the manifest file in your cloud bucket:

anno_key = "cloud_annotations"

results = dataset.annotate(
    anno_key,
    label_field="ground_truth",
    cloud_manifest="s3://voxel51/manifest.jsonl",
)

Alternatively, if your cloud manifest has the default name manifest.jsonl and exists in the root of the bucket containing the data in the sample collection being annotated, then you can simply pass cloud_manifest=True:

results = dataset.annotate(
    anno_key,
    label_field="ground_truth",
    cloud_manifest=True,
)

Note

The cloud manifest file must contain all media files in the sample collection being annotated.

Annotating cloud-backed datasets with V7 Darwin ¶

When using FiftyOne to annotate data with V7 Darwin, you can optionally follow the instructions below to instruct V7 to load media directly from S3, GCS, or Azure buckets rather than the default behavior of uploading copies of the media from your local machine.

First, follow these instructions to configure external storage for V7. Then, simply provide the external_storage parameter to annotate() and specify the sluggified external storage name:

anno_key = "cloud_annotations"

results = dataset.annotate(
    anno_key,
    label_field="ground_truth",
    external_storage="example-darwin-storage-slug",
    ...
)

Annotating cloud-backed datasets with Labelbox ¶

When using FiftyOne to annotate data with Labelbox, you can optionally follow the instructions below to instruct Labelbox to load media directly from S3 rather than the default behavior of uploading copies of the media.

This assumes that you have configured the S3 integration for Labelbox. If so, then you can provide the upload_media=False keyword argument to the annotate() method to pass URLs for your S3-backed media when creating Labelbox data rows.

results = dataset.annotate(
    anno_key,
    label_field="ground_truth",
    label_type="detections",
    classes=["dog", "cat"],
    backend="labelbox",
    upload_media=False,
)

Note

Google Cloud and Azure blob support will be added in the future. Currently, any Google Cloud, Azure, or local media will still be uploaded to Labelbox as usual.

AWS Lambda and Google Cloud Functions ¶

FiftyOne Teams 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:

https://${FIFTYONE_TEAMS_TOKEN}@pypi.fiftyone.ai/packages/fiftyone-0.6.6-py3-none-any.whl

Runtime

Lambda/GCFs cannot use services, so you must disable the media the cache by setting the following runtime environment variable:

export FIFTYONE_MEDIA_CACHE_SIZE_BYTES=-1  # disable media cache

From there, you can configure your database URI and any necessary cloud storage credentials via runtime environment variables as you normally would, eg:

export FIFTYONE_DATABASE_URI=mongodb://...