plugins.operators
Module contents
Builtin operators.
Classes:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Functions:
|
|
|
-
class
plugins.operators.EditFieldInfo(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.CloneSelectedSamples(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.CloneSampleField(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.CloneFrameField(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.RenameSampleField(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.RenameFrameField(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.ClearSampleField(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.ClearFrameField(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.DeleteSelectedSamples(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.DeleteSelectedLabels(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.DeleteSampleField(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.DeleteFrameField(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.CreateIndex(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.DropIndex(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.CreateSummaryField(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.UpdateSummaryField(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.DeleteSummaryField(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.AddGroupSlice(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.RenameGroupSlice(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.DeleteGroupSlice(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.ListSavedViews(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
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_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of the operator.
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.LoadSavedView(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.SaveView(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.EditSavedViewInfo(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.DeleteSavedView(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.ListWorkspaces(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
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_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of the operator.
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.LoadWorkspace(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.SaveWorkspace(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.EditWorkspaceInfo(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.DeleteWorkspace(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.SyncLastModifiedAt(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
Returns the resolved execution options.
resolve_output(ctx)Returns the resolved output property.
resolve_placement(ctx)Returns the resolved placement of the operator.
resolve_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of 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
- Returns
a
fiftyone.operators.types.Property, or None
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-
-
class
plugins.operators.ListFiles(_builtin=False) Bases:
fiftyone.operators.operator.OperatorAttributes:
The
OperatorConfigfor the operator.Whether the operator is builtin.
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.
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_type(ctx, type)Returns the resolved input or output property.
to_json()Returns a JSON representation of the operator.
-
execute(ctx) Executes the operator.
Subclasses must implement this method.
- Parameters
- Returns
JSON serializable data, or None
-
method_to_uri(method_name) Converts a method name to a URI.
- Parameters
method_name – the method name
- Returns
a URI
-
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
- 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
- Returns
a
fiftyone.operators.executor.ExecutionOptionsinstance
-
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
- 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
- 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
- Returns
a
fiftyone.operators.types.Placement, or None
-
resolve_type(ctx, type) Returns the resolved input or output property.
- Parameters
type – the type of property to resolve, either
"inputs"or"outputs"
- Returns
a
fiftyone.operators.types.Property, or None
-