Plugin Management & Development#

A plugin that contains utilities for managing your FiftyOne plugins and building new ones.

Installation#

fiftyone plugins download \
    https://github.com/voxel51/fiftyone-plugins \
    --plugin-names @voxel51/plugins

Refer to the main README for more information about managing downloaded plugins and developing plugins locally.

Usage#

  1. Launch the App:

import fiftyone as fo
import fiftyone.zoo as foz

dataset = foz.load_zoo_dataset("quickstart")
session = fo.launch_app(dataset)

  1. Press ` or click the Browse operations action to open the Operators list

  2. Select any of the operators listed below!

Operators#

install_plugin#

You can use this operator to install FiftyOne plugins from within the App.

This operator is essentially a wrapper around the plugin installation methods:

import fiftyone.plugins as fop

# Plugin installation
fop.download_plugin(...)

where the operator’s form allows you to choose between the following options:

  • Specify any GitHub URL that contains plugin(s) to install

  • Choose from any plugin listed in the FiftyOne Plugins README to install

manage_plugins#

You can use this operator to manage your FiftyOne plugins from within the App.

This operator is essentially a wrapper around the following plugin methods:

import fiftyone.plugins as fop

# Plugin enablement
fop.list_plugins()
fop.enable_plugin(name)
fop.disable_plugin(name)

# Plugin package requirements
fop.load_plugin_requirements(name)
fop.ensure_plugin_requirements(name)

where the operator’s form allows you to navigate between the available actions.

build_plugin_component#

plugin_builder_component

This operator walks you through the process of building a component for a given type of input, and selecting the component’s properties.

It currently supports the following component types:

  • Boolean: A way of selecting a true/false value

  • Float: A way of selecting a floating point number

  • Message: A way of displaying a message to the user

  • Radio group: A way of selecting one of a set of mutually exclusive options

Each of these component types has a set of properties that can be configured.

build_operator_skeleton#

build_operator

This operator walks you through the process of creating an operator.

You can use the UI to interactively define your operator, preview the skeleton code directly in the App, and even write the generated code to disk!