fiftyone.operators.executor¶

FiftyOne operator execution.

Copyright 2017-2024, Voxel51, Inc.
voxel51.com

Classes:

`ExecutionRunState`()	Enumeration of the available operator run states.
`InvocationRequest`(operator_uri[, params])	Represents a request to invoke an operator.
`ExecutionProgress`([progress, label])	Represents the status of an operator execution.
`Executor`([requests, logs])	Handles the execution phase of the operator lifecycle.
`ExecutionContext`([request_params, executor, …])	Represents the execution context of an operator.
`ExecutionResult`([result, executor, error, …])	Represents the result of an operator execution.
`ValidationError`(reason, property, path[, custom])	A validation error.
`ValidationContext`(ctx, inputs_property, operator)	Represents the validation context of an operator.
`ExecutionOptions`([…])	Represents the execution options of an operation.

Functions:

`execute_operator`(operator_uri[, ctx])	Executes the operator with the given name.
`execute_or_delegate_operator`(operator_uri, …)	Executes the operator with the given name.
`prepare_operator_executor`(operator_uri, …)
`do_execute_operator`(operator, ctx[, exhaust])
`resolve_type`(registry, operator_uri, …)	Resolves the inputs property type of the operator with the given name.
`resolve_type_with_context`(operator, context)	Resolves the “inputs” or “outputs” schema of an operator with the given context.
`resolve_execution_options`(registry, …)	Resolves the execution options of the operator with the given name.
`resolve_placement`(operator, request_params)	Resolves the placement of the operator with the given name.

Exceptions:

ExecutionError

An error that occurs while executing an operator.

class fiftyone.operators.executor.ExecutionRunState¶

Bases: object

Enumeration of the available operator run states.

Attributes:

`SCHEDULED`
`QUEUED`
`RUNNING`
`COMPLETED`
`FAILED`

SCHEDULED = 'scheduled'¶

QUEUED = 'queued'¶

RUNNING = 'running'¶

COMPLETED = 'completed'¶

FAILED = 'failed'¶

class fiftyone.operators.executor.InvocationRequest(operator_uri, params=None)¶

Bases: object

Represents a request to invoke an operator.

Parameters

operator_uri – the URI of the operator to invoke
params (None) – an optional dictionary of parameters

Methods:

to_json()

to_json()¶

class fiftyone.operators.executor.ExecutionProgress(progress=None, label=None)¶

Bases: object

Represents the status of an operator execution.

Parameters

progress (None) – an optional float between 0 and 1 (0% to 100%)
label (None) – an optional label to display

class fiftyone.operators.executor.Executor(requests=None, logs=None)¶

Bases: object

Handles the execution phase of the operator lifecycle.

Parameters

requests (None) – an optional list of InvocationRequest objects
logs (None) – an optional list of log messages

Methods:

`trigger`(operator_name[, params])	Triggers an invocation of the operator with the given name.
`log`(message)	Logs a message.
`to_json`()

trigger(operator_name, params=None)¶

Triggers an invocation of the operator with the given name.

Parameters

operator_name – the name of the operator
params (None) – a dictionary of parameters for the operator

Returns

a fiftyone.operators.message.GeneratedMessage containing instructions for the FiftyOne App to invoke the operator

log(message)¶: Logs a message.

to_json()¶

fiftyone.operators.executor.execute_operator(operator_uri, ctx=None, **kwargs)¶

Executes the operator with the given name.

Parameters

operator_uri – the URI of the operator
ctx (None) –
a dictionary of parameters defining the execution context. The supported keys are:
- dataset: a fiftyone.core.dataset.Dataset or the name of a dataset to process. This is required unless a view is provided
- view (None): an optional fiftyone.core.view.DatasetView to process
- selected ([]): an optional list of selected sample IDs
- selected_labels ([]): an optional list of selected labels in the format returned by fiftyone.core.session.Session.selected_labels
- current_sample (None): an optional ID of the current sample being processed
- params: a dictionary of parameters for the operator. Consult the operator’s documentation for details
- request_delegation (False): whether to request delegated execution, if supported by the operator
- delegation_target (None): an optional orchestrator on which to schedule the operation, if it is delegated
**kwargs – you can optionally provide any of the supported ctx keys as keyword arguments rather than including them in ctx

Returns

an ExecutionResult, or an asyncio.Task if you run this method in a notebook context

Raises

ExecutionError – if an error occurred while immediately executing an operation or scheduling a delegated operation

async fiftyone.operators.executor.execute_or_delegate_operator(operator_uri, request_params, exhaust=False)¶

Executes the operator with the given name.

Parameters

operator_uri – the URI of the operator
request_params – a dictionary of parameters for the operator
exhaust (False) – whether to immediately exhaust generator operators

Returns

an ExecutionResult

async fiftyone.operators.executor.prepare_operator_executor(operator_uri, request_params, set_progress=None, delegated_operation_id=None)¶

async fiftyone.operators.executor.do_execute_operator(operator, ctx, exhaust=False)¶

async fiftyone.operators.executor.resolve_type(registry, operator_uri, request_params)¶

Resolves the inputs property type of the operator with the given name.

Parameters

registry – an fiftyone.operators.registry.OperatorRegistry
operator_uri – the URI of the operator
request_params – a dictionary of request parameters

Returns

the type of the inputs fiftyone.operators.types.Property of the operator, or None

async fiftyone.operators.executor.resolve_type_with_context(operator, context)¶

Resolves the “inputs” or “outputs” schema of an operator with the given context.

Parameters

operator – the fiftyone.operators.Operator
context – the ExecutionContext of an operator

Returns

the “inputs” or “outputs” schema fiftyone.operators.types.Property of an operator, or None

async fiftyone.operators.executor.resolve_execution_options(registry, operator_uri, request_params)¶

Resolves the execution options of the operator with the given name.

Parameters

registry – an fiftyone.operators.registry.OperatorRegistry
operator_uri – the URI of the operator
request_params – a dictionary of request parameters

Returns

a fiftyone.operators.executor.ExecutionOptions or None

fiftyone.operators.executor.resolve_placement(operator, request_params)¶

Resolves the placement of the operator with the given name.

Parameters

operator – the fiftyone.operators.operator.Operator
request_params – a dictionary of request parameters

Returns

the placement of the operator or None

class fiftyone.operators.executor.ExecutionContext(request_params=None, executor=None, set_progress=None, delegated_operation_id=None, operator_uri=None, required_secrets=None)¶

Bases: object

Represents the execution context of an operator.

Operators can use the execution context to access the view, dataset, and selected samples, as well as to trigger other operators.

Parameters

request_params (None) – a optional dictionary of request parameters
executor (None) – an optional Executor instance
set_progress (None) – an optional function to set the progress of the current operation
delegated_operation_id (None) – an optional ID of the delegated operation
operator_uri (None) – the unique id of the operator
required_secrets (None) – the list of required secrets from the plugin’s definition

Attributes:

`dataset`	The `fiftyone.core.dataset.Dataset` being operated on.
`dataset_name`	The name of the `fiftyone.core.dataset.Dataset` being operated on.
`dataset_id`	The ID of the `fiftyone.core.dataset.Dataset` being operated on.
`view`	The `fiftyone.core.view.DatasetView` being operated on.
`has_custom_view`	Whether the operator has a custom view.
`spaces`	The current spaces layout in the FiftyOne App.
`selected`	The list of selected sample IDs (if any).
`selected_labels`	A list of selected labels (if any).
`extended_selection`	The extended selection of the view (if any).
`current_sample`	The ID of the current sample being processed (if any).
`user_id`	The ID of the user executing the operation, if known.
`user_request_token`	The request token authenticating the user executing the operation, if known.
`panel_id`	The ID of the panel that invoked the operator, if any.
`panel_state`	The current panel state.
`panel`	A `fiftyone.operators.panel.PanelRef` instance that you can use to read and write the state and data of the current panel.
`delegated`	Whether the operation was delegated.
`requesting_delegated_execution`	Whether delegated execution was requested for the operation.
`delegation_target`	The orchestrator to which the operation was delegated (if any).
`results`	A `dict` of results for the current operation.
`secrets`	A read-only mapping of keys to their resolved values.
`ops`	A `fiftyone.operators.operations.Operations` instance that you can use to trigger builtin operations on the current context.
`group_slice`	The current group slice of the view (if any).
`query_performance`	Whether query performance is enabled.

Methods:

`target_view`([param_name])	The target `fiftyone.core.view.DatasetView` for the operator being executed.
`prompt`(operator_uri[, params, on_success, …])	Prompts the user to execute the operator with the given URI.
`secret`(key)	Retrieves the secret with the given key.
`resolve_secret_values`(keys, **kwargs)	Resolves the values of the given secrets keys.
`trigger`(operator_name[, params])	Triggers an invocation of the operator with the given name.
`log`(message)	Logs a message to the browser console.
`set_progress`([progress, label])	Sets the progress of the current operation.
`store`(store_name)	Retrieves the execution store with the given name.
`serialize`()	Serializes the execution context.
`to_dict`()	Returns the properties of the execution context as a dict.

property dataset¶: The fiftyone.core.dataset.Dataset being operated on.

property dataset_name¶: The name of the fiftyone.core.dataset.Dataset being operated on.

property dataset_id¶: The ID of the fiftyone.core.dataset.Dataset being operated on.

property view¶: The fiftyone.core.view.DatasetView being operated on.

target_view(param_name='view_target')¶

The target fiftyone.core.view.DatasetView for the operator being executed.

Parameters: param_name ("view_target") – the name of the enum parameter defining the target view choice
Returns: a fiftyone.core.collections.SampleCollection

property has_custom_view¶: Whether the operator has a custom view.

property spaces¶: The current spaces layout in the FiftyOne App.

property selected¶: The list of selected sample IDs (if any).

property selected_labels¶

A list of selected labels (if any).

Items are dictionaries with the following keys:

label_id: the ID of the label
sample_id: the ID of the sample containing the label
field: the field name containing the label
frame_number: the frame number containing the label (only applicable to video samples)

property extended_selection¶: The extended selection of the view (if any).

property current_sample¶

The ID of the current sample being processed (if any).

When executed via the FiftyOne App, this is set when the user opens a sample in the modal.

property user_id¶: The ID of the user executing the operation, if known.

property user_request_token¶: The request token authenticating the user executing the operation, if known.

property panel_id¶: The ID of the panel that invoked the operator, if any.

property panel_state¶

The current panel state.

Only available when the operator is invoked from a panel.

property panel¶

A fiftyone.operators.panel.PanelRef instance that you can use to read and write the state and data of the current panel.

Only available when the operator is invoked from a panel.

property delegated¶: Whether the operation was delegated.

property requesting_delegated_execution¶: Whether delegated execution was requested for the operation.

property delegation_target¶: The orchestrator to which the operation was delegated (if any).

property results¶: A dict of results for the current operation.

property secrets¶: A read-only mapping of keys to their resolved values.

property ops¶: A fiftyone.operators.operations.Operations instance that you can use to trigger builtin operations on the current context.

property group_slice¶: The current group slice of the view (if any).

property query_performance¶: Whether query performance is enabled.

prompt(operator_uri, params=None, on_success=None, on_error=None, skip_prompt=False)¶

Prompts the user to execute the operator with the given URI.

Parameters

operator_uri – the URI of the operator
params (None) – a dictionary of parameters for the operator
on_success (None) – a callback to invoke if the user successfully executes the operator
on_error (None) – a callback to invoke if the execution fails
skip_prompt (False) – whether to skip the prompt

Returns

a fiftyone.operators.message.GeneratedMessage containing instructions for the FiftyOne App to prompt the user

secret(key)¶

Retrieves the secret with the given key.

Parameters: key – a secret key
Returns: the secret value

async resolve_secret_values(keys, **kwargs)¶

Resolves the values of the given secrets keys.

Parameters

keys – a list of secret keys
**kwargs – additional keyword arguments to pass to the secrets client for authentication if required

trigger(operator_name, params=None)¶

Triggers an invocation of the operator with the given name.

This method is only available when the operator is invoked via the FiftyOne App. You can check this via ctx.executor.

Example:

def execute(self, ctx):
    # Trigger the `reload_dataset` operator after this operator
    # finishes executing
    ctx.trigger("reload_dataset")

    # Immediately trigger the `reload_dataset` operator while a
    # generator operator is executing
    yield ctx.trigger("reload_dataset")

Parameters

operator_name – the name of the operator
params (None) – a dictionary of parameters for the operator

Returns

a fiftyone.operators.message.GeneratedMessage containing instructions for the FiftyOne App to invoke the operator

log(message)¶

Logs a message to the browser console.

Note

This method is only available to non-delegated operators. You can only use this method during the execution of an operator.

Parameters: message – a message to log
Returns: a fiftyone.operators.message.GeneratedMessage containing instructions for the FiftyOne App to invoke the operator

set_progress(progress=None, label=None)¶

Sets the progress of the current operation.

Parameters

progress (None) – an optional float between 0 and 1 (0% to 100%)
label (None) – an optional label to display

store(store_name)¶

Retrieves the execution store with the given name.

The store is automatically created if necessary.

Parameters: store_name – the name of the store
Returns: a fiftyone.operators.store.ExecutionStore

serialize()¶

Serializes the execution context.

Returns: a JSON dict

to_dict()¶: Returns the properties of the execution context as a dict.

class fiftyone.operators.executor.ExecutionResult(result=None, executor=None, error=None, error_message=None, validation_ctx=None, delegated=False, outputs_schema=None)¶

Bases: object

Represents the result of an operator execution.

Parameters

result (None) – the execution result
executor (None) – an Executor
error (None) – an error traceback, if an error occurred
error_message (None) – an error message, if an error occurred
validation_ctx (None) – a ValidationContext
delegated (False) – whether execution was delegated
outputs_schema (None) – a JSON dict representing the output schema of the operator

Attributes:

is_generator

Whether the result is a generator or an async generator.

Methods:

`raise_exceptions`()	Raises an `ExecutionError` (only) if the operation failed.
`to_exception`()	Returns an `ExecutionError` representing a failed execution result.
`to_json`()	Returns a JSON dict representation of the result.

property is_generator¶: Whether the result is a generator or an async generator.

raise_exceptions()¶: Raises an ExecutionError (only) if the operation failed.

to_exception()¶

Returns an ExecutionError representing a failed execution result.

Returns: a ExecutionError, or None if the execution did not fail

to_json()¶

Returns a JSON dict representation of the result.

Returns: a JSON dict

exception fiftyone.operators.executor.ExecutionError¶

Bases: Exception

An error that occurs while executing an operator.

args¶

with_traceback()¶: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

class fiftyone.operators.executor.ValidationError(reason, property, path, custom=False)¶

Bases: object

A validation error.

Parameters

reason – the reason
property – the property
path – the path

Methods:

to_json()

Returns a JSON dict representation of the error.

to_json()¶

Returns a JSON dict representation of the error.

Returns: a JSON dict

class fiftyone.operators.executor.ValidationContext(ctx, inputs_property, operator)¶

Bases: object

Represents the validation context of an operator.

Parameters

ctx – the ExecutionContext
inputs_property – the fiftyone.operators.types.Property of the operator inputs
operator – the fiftyone.operators.operator.Operator

Methods:

`to_json`()	Returns a JSON dict representation of the context.
`add_error`(error)	Adds a validation error.
`validate_enum`(path, property, value)	Validates an enum value.
`validate_list`(path, property, value)	Validates a list value.
`validate_property`(path, property, value)	Validates a property value.
`validate_object`(path, property, value)	Validates an object value.
`validate_primitive`(path, property, value)	Validates a primitive value.
`exists_or_non_required`(property, value)

to_json()¶

Returns a JSON dict representation of the context.

Returns: a JSON dict

add_error(error)¶

Adds a validation error.

Parameters: error – a ValidationError

validate_enum(path, property, value)¶

Validates an enum value.

Parameters

path – the path to the property
property – the fiftyone.operators.types.Property
value – the value to validate

Returns

a ValidationError, if the value is invalid

validate_list(path, property, value)¶

Validates a list value.

Parameters

path – the path to the property
property – the fiftyone.operators.types.Property
value – the value to validate

Returns

a ValidationError, if the value is invalid

validate_property(path, property, value)¶

Validates a property value.

Parameters

path – the path to the property
property – the fiftyone.operators.types.Property
value – the value to validate

Returns

a ValidationError, if the value is invalid

validate_object(path, property, value)¶

Validates an object value.

Parameters

path – the path to the property
property – the fiftyone.operators.types.Property
value – the value to validate

Returns

a ValidationError, if the value is invalid

validate_primitive(path, property, value)¶

Validates a primitive value.

Parameters

path – the path to the property
property – the fiftyone.operators.types.Property
value – the value to validate

Returns

a ValidationError, if the value is invalid

exists_or_non_required(property, value)¶

class fiftyone.operators.executor.ExecutionOptions(allow_immediate_execution=True, allow_delegated_execution=False, default_choice_to_delegated=False)¶

Bases: object

Represents the execution options of an operation.

Parameters

allow_immediate_execution (True) – whether the operation can be executed immediately
allow_delegated_execution (False) – whether the operation can be delegated to an orchestrator
default_choice_to_delegated (False) – whether to default to delegated execution, if allowed

Attributes:

`allow_immediate_execution`
`allow_delegated_execution`
`default_choice_to_delegated`
`available_orchestrators`
`orchestrator_registration_enabled`

Methods:

`update`([available_orchestrators])
`to_dict`()

property allow_immediate_execution¶

property allow_delegated_execution¶

property default_choice_to_delegated¶

property available_orchestrators¶

property orchestrator_registration_enabled¶

update(available_orchestrators=None)¶

to_dict()¶