plugins.operators

• plugins.operators.model_evaluation
  • plugins.operators.model_evaluation.utils
    • CustomCodeViewReason
      • CustomCodeViewReason.TOO_MANY_CATEGORIES
      • CustomCodeViewReason.TOO_MANY_INT_CATEGORIES
      • CustomCodeViewReason.FLOAT_TYPE
      • CustomCodeViewReason.SLOW
      • CustomCodeViewReason.encode()
      • CustomCodeViewReason.replace()
      • CustomCodeViewReason.split()
      • CustomCodeViewReason.rsplit()
      • CustomCodeViewReason.join()
      • CustomCodeViewReason.capitalize()
      • CustomCodeViewReason.casefold()
      • CustomCodeViewReason.title()
      • CustomCodeViewReason.center()
      • CustomCodeViewReason.count()
      • CustomCodeViewReason.expandtabs()
      • CustomCodeViewReason.find()
      • CustomCodeViewReason.partition()
      • CustomCodeViewReason.index()
      • CustomCodeViewReason.ljust()
      • CustomCodeViewReason.lower()
      • CustomCodeViewReason.lstrip()
      • CustomCodeViewReason.rfind()
      • CustomCodeViewReason.rindex()
      • CustomCodeViewReason.rjust()
      • CustomCodeViewReason.rstrip()
      • CustomCodeViewReason.rpartition()
      • CustomCodeViewReason.splitlines()
      • CustomCodeViewReason.strip()
      • CustomCodeViewReason.swapcase()
      • CustomCodeViewReason.translate()
      • CustomCodeViewReason.upper()
      • CustomCodeViewReason.startswith()
      • CustomCodeViewReason.endswith()
      • CustomCodeViewReason.removeprefix()
      • CustomCodeViewReason.removesuffix()
      • CustomCodeViewReason.isascii()
      • CustomCodeViewReason.islower()
      • CustomCodeViewReason.isupper()
      • CustomCodeViewReason.istitle()
      • CustomCodeViewReason.isspace()
      • CustomCodeViewReason.isdecimal()
      • CustomCodeViewReason.isdigit()
      • CustomCodeViewReason.isnumeric()
      • CustomCodeViewReason.isalpha()
      • CustomCodeViewReason.isalnum()
      • CustomCodeViewReason.isidentifier()
      • CustomCodeViewReason.isprintable()
      • CustomCodeViewReason.zfill()
      • CustomCodeViewReason.format()
      • CustomCodeViewReason.format_map()
      • CustomCodeViewReason.maketrans()
    • ShowOptionsMethod
      • ShowOptionsMethod.CODE
      • ShowOptionsMethod.CHECKBOX
      • ShowOptionsMethod.EMPTY
      • ShowOptionsMethod.AUTOCOMPLETE
      • ShowOptionsMethod.encode()
      • ShowOptionsMethod.replace()
      • ShowOptionsMethod.split()
      • ShowOptionsMethod.rsplit()
      • ShowOptionsMethod.join()
      • ShowOptionsMethod.capitalize()
      • ShowOptionsMethod.casefold()
      • ShowOptionsMethod.title()
      • ShowOptionsMethod.center()
      • ShowOptionsMethod.count()
      • ShowOptionsMethod.expandtabs()
      • ShowOptionsMethod.find()
      • ShowOptionsMethod.partition()
      • ShowOptionsMethod.index()
      • ShowOptionsMethod.ljust()
      • ShowOptionsMethod.lower()
      • ShowOptionsMethod.lstrip()
      • ShowOptionsMethod.rfind()
      • ShowOptionsMethod.rindex()
      • ShowOptionsMethod.rjust()
      • ShowOptionsMethod.rstrip()
      • ShowOptionsMethod.rpartition()
      • ShowOptionsMethod.splitlines()
      • ShowOptionsMethod.strip()
      • ShowOptionsMethod.swapcase()
      • ShowOptionsMethod.translate()
      • ShowOptionsMethod.upper()
      • ShowOptionsMethod.startswith()
      • ShowOptionsMethod.endswith()
      • ShowOptionsMethod.removeprefix()
      • ShowOptionsMethod.removesuffix()
      • ShowOptionsMethod.isascii()
      • ShowOptionsMethod.islower()
      • ShowOptionsMethod.isupper()
      • ShowOptionsMethod.istitle()
      • ShowOptionsMethod.isspace()
      • ShowOptionsMethod.isdecimal()
      • ShowOptionsMethod.isdigit()
      • ShowOptionsMethod.isnumeric()
      • ShowOptionsMethod.isalpha()
      • ShowOptionsMethod.isalnum()
      • ShowOptionsMethod.isidentifier()
      • ShowOptionsMethod.isprintable()
      • ShowOptionsMethod.zfill()
      • ShowOptionsMethod.format()
      • ShowOptionsMethod.format_map()
      • ShowOptionsMethod.maketrans()
    • ScenarioType
      • ScenarioType.VIEW
      • ScenarioType.CUSTOM_CODE
      • ScenarioType.LABEL_ATTRIBUTE
      • ScenarioType.SAMPLE_FIELD
      • ScenarioType.encode()
      • ScenarioType.replace()
      • ScenarioType.split()
      • ScenarioType.rsplit()
      • ScenarioType.join()
      • ScenarioType.capitalize()
      • ScenarioType.casefold()
      • ScenarioType.title()
      • ScenarioType.center()
      • ScenarioType.count()
      • ScenarioType.expandtabs()
      • ScenarioType.find()
      • ScenarioType.partition()
      • ScenarioType.index()
      • ScenarioType.ljust()
      • ScenarioType.lower()
      • ScenarioType.lstrip()
      • ScenarioType.rfind()
      • ScenarioType.rindex()
      • ScenarioType.rjust()
      • ScenarioType.rstrip()
      • ScenarioType.rpartition()
      • ScenarioType.splitlines()
      • ScenarioType.strip()
      • ScenarioType.swapcase()
      • ScenarioType.translate()
      • ScenarioType.upper()
      • ScenarioType.startswith()
      • ScenarioType.endswith()
      • ScenarioType.removeprefix()
      • ScenarioType.removesuffix()
      • ScenarioType.isascii()
      • ScenarioType.islower()
      • ScenarioType.isupper()
      • ScenarioType.istitle()
      • ScenarioType.isspace()
      • ScenarioType.isdecimal()
      • ScenarioType.isdigit()
      • ScenarioType.isnumeric()
      • ScenarioType.isalpha()
      • ScenarioType.isalnum()
      • ScenarioType.isidentifier()
      • ScenarioType.isprintable()
      • ScenarioType.zfill()
      • ScenarioType.format()
      • ScenarioType.format_map()
      • ScenarioType.maketrans()
    • get_scenario_example()
  • Module contents
    • dataset_serialize_deserialize()
    • ConfigureScenario
      • ConfigureScenario.last_view_type_used
      • ConfigureScenario.config
      • ConfigureScenario.get_dataset()
      • ConfigureScenario.get_samples_count()
      • ConfigureScenario.get_default_for_distribution_preview()
      • ConfigureScenario.render_name_input()
      • ConfigureScenario.render_scenario_types()
      • ConfigureScenario.extract_evaluation_keys()
      • ConfigureScenario.extract_evaluation_id()
      • ConfigureScenario.get_subset_def_data_for_eval_key()
      • ConfigureScenario.get_evaluations_results()
      • ConfigureScenario.get_subset_def_data_for_eval()
      • ConfigureScenario.get_sample_distribution()
      • ConfigureScenario.convert_to_plotly_data()
      • ConfigureScenario.is_sample_distribution_enabled_for_custom_code()
      • ConfigureScenario.render_empty_sample_distribution()
      • ConfigureScenario.get_label_attribute_path()
      • ConfigureScenario.render_sample_distribution()
      • ConfigureScenario.render_plot_preview_toggle()
      • ConfigureScenario.render_sample_distribution_graph()
      • ConfigureScenario.get_custom_code_key()
      • ConfigureScenario.extract_custom_code()
      • ConfigureScenario.render_custom_code()
      • ConfigureScenario.render_no_values_warning()
      • ConfigureScenario.render_use_custom_code_warning()
      • ConfigureScenario.render_use_custom_code_instead()
      • ConfigureScenario.get_saved_view_scenarios_picker_type()
      • ConfigureScenario.render_saved_views()
      • ConfigureScenario.get_scenario_values_key()
      • ConfigureScenario.get_selected_values()
      • ConfigureScenario.render_checkbox_view()
      • ConfigureScenario.get_scenarios_picker_type()
      • ConfigureScenario.render_auto_complete_view()
      • ConfigureScenario.render_scenario_picker_view()
      • ConfigureScenario.get_valid_label_attribute_path_options()
      • ConfigureScenario.render_label_attribute()
      • ConfigureScenario.get_valid_sample_field_path_options()
      • ConfigureScenario.render_sample_fields()
      • ConfigureScenario.get_scenario_type()
      • ConfigureScenario.get_modal_title()
      • ConfigureScenario.get_scenario_names()
      • ConfigureScenario.resolve_input()
      • ConfigureScenario.render_custom_code_content()
      • ConfigureScenario.execute()
      • ConfigureScenario.add_secrets()
      • ConfigureScenario.builtin
      • ConfigureScenario.method_to_uri()
      • ConfigureScenario.name
      • ConfigureScenario.resolve_delegation()
      • ConfigureScenario.resolve_execution_options()
      • ConfigureScenario.resolve_output()
      • ConfigureScenario.resolve_placement()
      • ConfigureScenario.resolve_run_name()
      • ConfigureScenario.resolve_type()
      • ConfigureScenario.to_json()
      • ConfigureScenario.uri

• plugins.operators.group_by
  • GroupBy
    • GroupBy.config
    • GroupBy.resolve_placement()
    • GroupBy.resolve_input()
    • GroupBy.execute()
    • GroupBy.add_secrets()
    • GroupBy.builtin
    • GroupBy.method_to_uri()
    • GroupBy.name
    • GroupBy.resolve_delegation()
    • GroupBy.resolve_execution_options()
    • GroupBy.resolve_output()
    • GroupBy.resolve_run_name()
    • GroupBy.resolve_type()
    • GroupBy.to_json()
    • GroupBy.uri

Module contents

Builtin operators.

Copyright 2017-2025, Voxel51, Inc.

voxel51.com

Classes:

EditFieldInfo([_builtin])
EditFieldValues([_builtin])
CloneSelectedSamples([_builtin])
CloneSampleField([_builtin])
CloneFrameField([_builtin])
RenameSampleField([_builtin])
RenameFrameField([_builtin])
ClearSampleField([_builtin])
ClearFrameField([_builtin])
DeleteSelectedSamples([_builtin])
DeleteSelectedLabels([_builtin])
DeleteSampleField([_builtin])
DeleteFrameField([_builtin])
CreateIndex([_builtin])
DropIndex([_builtin])
CreateSummaryField([_builtin])
UpdateSummaryField([_builtin])
DeleteSummaryField([_builtin])
AddGroupSlice([_builtin])
RenameGroupSlice([_builtin])
DeleteGroupSlice([_builtin])
ListSavedViews([_builtin])
LoadSavedView([_builtin])
SaveView([_builtin])
EditSavedViewInfo([_builtin])
DeleteSavedView([_builtin])
ListWorkspaces([_builtin])
LoadWorkspace([_builtin])
SaveWorkspace([_builtin])
EditWorkspaceInfo([_builtin])
DeleteWorkspace([_builtin])
SyncLastModifiedAt([_builtin])
ListFiles([_builtin])

Functions:

get_default_path_for_filesystem(fs)
list_filesystems()
list_files(dirpath)
register(p)

class plugins.operators.EditFieldInfo(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.EditFieldValues(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.CloneSelectedSamples(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.CloneSampleField(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.CloneFrameField(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.RenameSampleField(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.RenameFrameField(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.ClearSampleField(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.ClearFrameField(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.DeleteSelectedSamples(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.DeleteSelectedLabels(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.DeleteSampleField(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.DeleteFrameField(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.CreateIndex(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.DropIndex(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.CreateSummaryField(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.UpdateSummaryField(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.DeleteSummaryField(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.AddGroupSlice(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.RenameGroupSlice(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.DeleteGroupSlice(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.ListSavedViews(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

execute(ctx)	Executes the operator.
add_secrets(secrets)	Adds secrets to the operator.
method_to_uri(method_name)	Converts a method name to a URI.
resolve_delegation(ctx)	Returns the resolved forced delegation flag.
resolve_execution_options(ctx)	Returns the resolved execution options.
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.
resolve_run_name(ctx)	Returns the resolved run name of the operator.
resolve_type(ctx, type)	Returns the resolved input or output property.
to_json()	Returns a JSON representation of the operator.

property config

The OperatorConfig for the operator.

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.LoadSavedView(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.SaveView(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.EditSavedViewInfo(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.DeleteSavedView(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.ListWorkspaces(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

execute(ctx)	Executes the operator.
add_secrets(secrets)	Adds secrets to the operator.
method_to_uri(method_name)	Converts a method name to a URI.
resolve_delegation(ctx)	Returns the resolved forced delegation flag.
resolve_execution_options(ctx)	Returns the resolved execution options.
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.
resolve_run_name(ctx)	Returns the resolved run name of the operator.
resolve_type(ctx, type)	Returns the resolved input or output property.
to_json()	Returns a JSON representation of the operator.

property config

The OperatorConfig for the operator.

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.LoadWorkspace(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.SaveWorkspace(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.EditWorkspaceInfo(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.DeleteWorkspace(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.SyncLastModifiedAt(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

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

property config

The OperatorConfig for the operator.

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

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

class plugins.operators.ListFiles(_builtin=False)

Bases: Operator

Attributes:

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

Methods:

execute(ctx)	Executes the operator.
add_secrets(secrets)	Adds secrets to the operator.
method_to_uri(method_name)	Converts a method name to a URI.
resolve_delegation(ctx)	Returns the resolved forced delegation flag.
resolve_execution_options(ctx)	Returns the resolved execution options.
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.
resolve_run_name(ctx)	Returns the resolved run name of the operator.
resolve_type(ctx, type)	Returns the resolved input or output property.
to_json()	Returns a JSON representation of the operator.

property config

The OperatorConfig for the operator.

execute(ctx)

Executes the operator.

Subclasses must implement this method.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

JSON serializable data, or None

add_secrets(secrets)

Adds secrets to the operator.

Parameters:

secrets – a list of secrets

property builtin

Whether the operator is builtin.

method_to_uri(method_name)

Converts a method name to a URI.

Parameters:

method_name – the method name

Returns:

a URI

property name

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

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

resolve_run_name(ctx)

Returns the resolved run name of the operator.

Subclasses can implement this method to define the run name of the operator.

Parameters:

ctx – the fiftyone.operators.executor.ExecutionContext

Returns:

a string, 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

to_json()

Returns a JSON representation of the operator.

Returns:

a JSON dict

property uri

The unique identifier of the operator: plugin_name/operator_name.

plugins.operators.get_default_path_for_filesystem(fs)

plugins.operators.list_filesystems()

plugins.operators.list_files(dirpath)

plugins.operators.register(p)