fiftyone.operators.operator

FiftyOne operators.

Copyright 2017-2024, Voxel51, Inc.

voxel51.com

Classes:

OperatorConfig(name[, label, description, …])	A configuration for an operator.
Operator([_builtin])	A FiftyOne operator.

class fiftyone.operators.operator.OperatorConfig(name, label=None, description=None, dynamic=False, execute_as_generator=False, unlisted=False, on_startup=False, on_dataset_open=False, disable_schema_validation=False, delegation_target=None, icon=None, light_icon=None, dark_icon=None, allow_immediate_execution=True, allow_delegated_execution=False, default_choice_to_delegated=False, resolve_execution_options_on_change=None, **kwargs)

Bases: object

A configuration for an operator.

Parameters

• name – the name of the operator

• label (name) – a label for the operator

• description (None) – a description of the operator

• dynamic (False) – whether the operator inputs and outputs should be resolved when the input/output changes

• execute_as_generator (False) – whether the operator should be executed as a generator

• unlisted (False) – whether the operator should be hidden from the Operator Browser

• on_startup (False) – whether the operator should be executed on startup

• on_dataset_open (False) – whether the operator should be executed on opening a dataset

• disable_schema_validation (False) – whether the operator built-in schema validation should be disabled

• icon (None) – icon to show for the operator in the Operator Browser

• light_icon (None) – icon to show for the operator in the Operator Browser when the App is in the light mode

• dark_icon (None) – icon to show for the operator in the Operator Browser when the App is in the dark mode

• allow_immediate_execution (True) – whether the operator should allow immediate execution

• allow_delegated_execution (False) – whether the operator should allow delegated execution

• default_choice_to_delegated (False) – whether to default to delegated execution, if allowed

• resolve_execution_options_on_change (None) – whether to resolve execution options dynamically when inputs change. By default, this behavior will match the dynamic setting

Methods:

to_json()

to_json()

class fiftyone.operators.operator.Operator(_builtin=False)

Bases: object

A FiftyOne operator.

Operators represent an operation and the details of how to execute it.

FiftyOne operators contain enough information for a user interface to render a form or button allowing a user to execute the operation.

Attributes:

name
uri	The unique identifier of the operator: plugin_name/operator_name.
builtin	Whether the operator is builtin.
config	The OperatorConfig for the operator.

Methods:

resolve_delegation(ctx)	Returns the resolved forced delegation flag.
resolve_execution_options(ctx)	Returns the resolved execution options.
execute(ctx)	Executes the operator.
resolve_type(ctx, type)	Returns the resolved input or output property.
resolve_input(ctx)	Returns the resolved input property.
resolve_output(ctx)	Returns the resolved output property.
resolve_placement(ctx)	Returns the resolved placement of the operator.
method_to_uri(method_name)	Converts a method name to a URI.
to_json()	Returns a JSON representation of the operator.
add_secrets(secrets)	Adds secrets to the operator.

property name

property uri

The unique identifier of the operator: plugin_name/operator_name.

property builtin

Whether the operator is builtin.

property config

The OperatorConfig for the operator.

resolve_delegation(ctx)

Returns the resolved forced delegation flag.

Subclasses can implement this method to decide if delegated execution should be forced for the given operation.

Parameters

ctx – the fiftyone.operators.executor.ExecutionContext

Returns

whether the operation should be delegated (True), run immediately (False), or None to defer to resolve_execution_options() to specify the available options

resolve_execution_options(ctx)

Returns the resolved execution options.

Subclasses can implement this method to define the execution options available for the operation.

Parameters

ctx – the fiftyone.operators.executor.ExecutionContext

Returns

a fiftyone.operators.executor.ExecutionOptions instance

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters

ctx – the fiftyone.operators.executor.ExecutionContext

Returns

JSON serializable data, or None

resolve_type(ctx, type)

Returns the resolved input or output property.

Parameters

• ctx – the fiftyone.operators.executor.ExecutionContext

• type – the type of property to resolve, either "inputs" or "outputs"

Returns

a fiftyone.operators.types.Property, or None

resolve_input(ctx)

Returns the resolved input property.

Subclasses can implement this method to define the inputs to the operator. This method should never be called directly. Instead use resolve_type().

By default, this method is called once when the operator is created. If the operator is dynamic, this method is called each time the input changes.

Parameters

ctx – the fiftyone.operators.executor.ExecutionContext

Returns

a fiftyone.operators.types.Property, or None

resolve_output(ctx)

Returns the resolved output property.

Subclasses can implement this method to define the outputs of the operator.

By default, this method is called once when the operator is created. If the operator is dynamic, this method is called after the operator is executed.

Parameters

ctx – the fiftyone.operators.executor.ExecutionContext

Returns

a fiftyone.operators.types.Property, or None

resolve_placement(ctx)

Returns the resolved placement of the operator.

Subclasses can implement this method to define the placement of the operator.

Parameters

ctx – the fiftyone.operators.executor.ExecutionContext

Returns

a fiftyone.operators.types.Placement, or None

method_to_uri(method_name)

Converts a method name to a URI.

Parameters

method_name – the method name

Returns

a URI

to_json()

Returns a JSON representation of the operator.

Returns

a JSON dict

add_secrets(secrets)

Adds secrets to the operator.

Parameters

secrets – a list of secrets