# fiftyone.brain.internal.models.torch PyTorch utilities. Copyright 2017-2026, Voxel51, Inc.
[voxel51.com](https://voxel51.com/)

**Classes:** | [`TorchImageModelConfig`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig)(d) | Configuration for running a [`TorchImageModel`](#fiftyone.brain.internal.models.torch.TorchImageModel). | |---------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------| | [`TorchImageModel`](#fiftyone.brain.internal.models.torch.TorchImageModel)(config) | Wrapper for evaluating a Torch model on images whose state dict is stored privately by the Brain. | ### *class* fiftyone.brain.internal.models.torch.TorchImageModelConfig(d) Bases: [`TorchImageModelConfig`](fiftyone.utils.torch.md#fiftyone.utils.torch.TorchImageModelConfig), [`HasBrainModel`](fiftyone.brain.internal.models.md#fiftyone.brain.internal.models.HasBrainModel) Configuration for running a [`TorchImageModel`](#fiftyone.brain.internal.models.torch.TorchImageModel). See [`fiftyone.utils.torch.TorchImageModelConfig`](fiftyone.utils.torch.md#fiftyone.utils.torch.TorchImageModelConfig) for additional parameters. * **Parameters:** * **model_name** (*None*) – the name of the Brain model state dict to load * **model_path** (*None*) – the path to a state dict on disk to load **Methods:** | [`attributes`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.attributes)() | Returns a list of class attributes to be serialized. | |------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| | [`builder`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.builder)() | Returns a ConfigBuilder instance for this class. | | [`copy`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.copy)() | Returns a deep copy of the object. | | [`custom_attributes`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.custom_attributes)([dynamic, private]) | Returns a customizable list of class attributes. | | [`default`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.default)() | Returns the default config instance. | | [`download_model_if_necessary`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.download_model_if_necessary)() | Downloads the published model specified by the config, if necessary. | | [`from_dict`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.from_dict)(d) | Constructs a Config object from a JSON dictionary. | | [`from_json`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.from_json)(path, \*args, \*\*kwargs) | Constructs a Serializable object from a JSON file. | | [`from_kwargs`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.from_kwargs)(\*\*kwargs) | Constructs a Config object from keyword arguments. | | [`from_str`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.from_str)(s, \*args, \*\*kwargs) | Constructs a Serializable object from a JSON string. | | [`get_class_name`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.get_class_name)() | Returns the fully-qualified class name string of this object. | | [`init`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.init)(d) | Initializes the published model config. | | [`load_default`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.load_default)() | Loads the default config instance from file. | | [`parse_array`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.parse_array)(d, key[, default]) | Parses a raw array attribute. | | [`parse_bool`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.parse_bool)(d, key[, default]) | Parses a boolean value. | | [`parse_categorical`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.parse_categorical)(d, key, choices[, default]) | Parses a categorical JSON field, which must take a value from among the given choices. | | [`parse_dict`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.parse_dict)(d, key[, default]) | Parses a dictionary attribute. | | [`parse_int`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.parse_int)(d, key[, default]) | Parses an integer attribute. | | [`parse_mutually_exclusive_fields`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.parse_mutually_exclusive_fields)(fields) | Parses a mutually exclusive dictionary of pre-parsed fields, which must contain exactly one field with a truthy value. | | [`parse_number`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.parse_number)(d, key[, default]) | Parses a number attribute. | | [`parse_object`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.parse_object)(d, key, cls[, default]) | Parses an object attribute. | | [`parse_object_array`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.parse_object_array)(d, key, cls[, default]) | Parses an array of objects. | | [`parse_object_dict`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.parse_object_dict)(d, key, cls[, default]) | Parses a dictionary whose values are objects. | | [`parse_path`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.parse_path)(d, key[, default]) | Parses a path attribute. | | [`parse_raw`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.parse_raw)(d, key[, default]) | Parses a raw (arbitrary) JSON field. | | [`parse_string`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.parse_string)(d, key[, default]) | Parses a string attribute. | | [`serialize`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.serialize)([reflective]) | Serializes the object into a dictionary. | | [`to_str`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.to_str)([pretty_print]) | Returns a string representation of this object. | | [`validate_all_or_nothing_fields`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.validate_all_or_nothing_fields)(fields) | Validates a dictionary of pre-parsed fields checking that either all or none of the fields have a truthy value. | | [`write_json`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig.write_json)(path[, pretty_print]) | Serializes the object and writes it to disk. | #### attributes() Returns a list of class attributes to be serialized. This method is called internally by `serialize()` to determine the class attributes to serialize. Subclasses can override this method, but, by default, all attributes in vars(self) are returned, minus private attributes, i.e., those starting with “_”. The order of the attributes in this list is preserved when serializing objects, so a common pattern is for subclasses to override this method if they want their JSON files to be organized in a particular way. * **Returns:** a list of class attributes to be serialized #### *classmethod* builder() Returns a ConfigBuilder instance for this class. #### copy() Returns a deep copy of the object. * **Returns:** a Serializable instance #### custom_attributes(dynamic=False, private=False) Returns a customizable list of class attributes. By default, all attributes in vars(self) are returned, minus private attributes (those starting with “_”). * **Parameters:** * **dynamic** – whether to include dynamic properties, e.g., those defined by getter/setter methods or the `@property` decorator. By default, this is False * **private** – whether to include private properties, i.e., those starting with “_”. By default, this is False * **Returns:** a list of class attributes #### *classmethod* default() Returns the default config instance. By default, this method instantiates the class from an empty dictionary, which will only succeed if all attributes are optional. Otherwise, subclasses should override this method to provide the desired default configuration. #### download_model_if_necessary() Downloads the published model specified by the config, if necessary. After this method is called, the `model_path` attribute will always contain the path to the model on disk. #### *classmethod* from_dict(d) Constructs a Config object from a JSON dictionary. Config subclass constructors accept JSON dictionaries, so this method simply passes the dictionary to cls(). * **Parameters:** **d** – a dict of fields expected by cls * **Returns:** an instance of cls #### *classmethod* from_json(path, \*args, \*\*kwargs) Constructs a Serializable object from a JSON file. Subclasses may override this method, but, by default, this method simply reads the JSON and calls from_dict(), which subclasses must implement. * **Parameters:** * **path** – the path to the JSON file on disk * **\*args** – optional positional arguments for `self.from_dict()` * **\*\*kwargs** – optional keyword arguments for `self.from_dict()` * **Returns:** an instance of the Serializable class #### *classmethod* from_kwargs(\*\*kwargs) Constructs a Config object from keyword arguments. * **Parameters:** **\*\*kwargs** – keyword arguments that define the fields expected by cls * **Returns:** an instance of cls #### *classmethod* from_str(s, \*args, \*\*kwargs) Constructs a Serializable object from a JSON string. Subclasses may override this method, but, by default, this method simply parses the string and calls from_dict(), which subclasses must implement. * **Parameters:** * **s** – a JSON string representation of a Serializable object * **\*args** – optional positional arguments for `self.from_dict()` * **\*\*kwargs** – optional keyword arguments for `self.from_dict()` * **Returns:** an instance of the Serializable class #### *classmethod* get_class_name() Returns the fully-qualified class name string of this object. #### init(d) Initializes the published model config. This method should be called by `ModelConfig.__init__()`, and it performs the following tasks: - Parses the `model_name` and `model_path` parameters - Populates any default parameters in the provided ModelConfig dict * **Parameters:** **d** – a ModelConfig dict * **Returns:** a ModelConfig dict with any default parameters populated #### *classmethod* load_default() Loads the default config instance from file. Subclasses must implement this method if they intend to support default instances. #### *static* parse_array(d, key, default=) Parses a raw array attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **default** – a default list to return if key is not present * **Returns:** a list of raw (untouched) values * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default value was provided and the key was not found in the dictionary #### *static* parse_bool(d, key, default=) Parses a boolean value. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **default** – a default bool to return if key is not present * **Returns:** True/False * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default value was provided and the key was not found in the dictionary #### *static* parse_categorical(d, key, choices, default=) Parses a categorical JSON field, which must take a value from among the given choices. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **choices** – either an iterable of possible values or an enum-like class whose attributes define the possible values * **default** – a default value to return if key is not present * **Returns:** the raw (untouched) value of the given field, which is equal to a value from `choices` * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the key was present in the dictionary but its value was not an allowed choice, or if no default value was provided and the key was not found in the dictionary #### *static* parse_dict(d, key, default=) Parses a dictionary attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **default** – a default dict to return if key is not present * **Returns:** a dictionary * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default value was provided and the key was not found in the dictionary #### *static* parse_int(d, key, default=) Parses an integer attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **default** – a default integer value to return if key is not present * **Returns:** an int * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default value was provided and the key was not found in the dictionary #### *static* parse_mutually_exclusive_fields(fields) Parses a mutually exclusive dictionary of pre-parsed fields, which must contain exactly one field with a truthy value. * **Parameters:** **fields** – a dictionary of pre-parsed fields * **Returns:** the (field, value) that was set * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if zero or more than one truthy value was found #### *static* parse_number(d, key, default=) Parses a number attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **default** – a default numeric value to return if key is not present * **Returns:** a number (e.g. int, float) * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default value was provided and the key was not found in the dictionary #### *static* parse_object(d, key, cls, default=) Parses an object attribute. The value of d[key] can be either an instance of cls or a serialized dict from an instance of cls. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **cls** – the class of d[key] * **default** – a default cls instance to return if key is not present * **Returns:** an instance of cls * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default value was provided and the key was not found in the dictionary #### *static* parse_object_array(d, key, cls, default=) Parses an array of objects. The values in d[key] can be either instances of cls or serialized dicts from instances of cls. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **cls** – the class of the elements of list d[key] * **default** – the default list to return if key is not present * **Returns:** a list of cls instances * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default value was provided and the key was not found in the dictionary #### *static* parse_object_dict(d, key, cls, default=) Parses a dictionary whose values are objects. The values in d[key] can be either instances of cls or serialized dicts from instances of cls. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **cls** – the class of the values of dictionary d[key] * **default** – the default dict of cls instances to return if key is not present * **Returns:** a dictionary whose values are cls instances * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default value was provided and the key was not found in the dictionary #### *static* parse_path(d, key, default=) Parses a path attribute. The path is converted to an absolute path if necessary via `os.path.abspath(os.path.expanduser(value))`. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **default** – a default string to return if key is not present * **Returns:** a path string * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default value was provided and the key was not found in the dictionary #### *static* parse_raw(d, key, default=) Parses a raw (arbitrary) JSON field. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **default** – a default value to return if key is not present * **Returns:** the raw (untouched) value of the given field * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if no default value was provided and the key was not found in the dictionary #### *static* parse_string(d, key, default=) Parses a string attribute. * **Parameters:** * **d** – a JSON dictionary * **key** – the key to parse * **default** – a default string to return if key is not present * **Returns:** a string * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if the field value was the wrong type or no default value was provided and the key was not found in the dictionary #### serialize(reflective=False) Serializes the object into a dictionary. Serialization is applied recursively to all attributes in the object, including element-wise serialization of lists and dictionary values. * **Parameters:** **reflective** – whether to include reflective attributes when serializing the object. By default, this is False * **Returns:** a JSON dictionary representation of the object #### to_str(pretty_print=True, \*\*kwargs) Returns a string representation of this object. * **Parameters:** * **pretty_print** – whether to render the JSON in human readable format with newlines and indentations. By default, this is True * **\*\*kwargs** – optional keyword arguments for `self.serialize()` * **Returns:** a string representation of the object #### *static* validate_all_or_nothing_fields(fields) Validates a dictionary of pre-parsed fields checking that either all or none of the fields have a truthy value. * **Parameters:** **fields** – a dictionary of pre-parsed fields * **Raises:** [**ConfigError**](fiftyone.zoo.md#fiftyone.zoo.ConfigError) – if some values are truth and some are not #### write_json(path, pretty_print=False, \*\*kwargs) Serializes the object and writes it to disk. * **Parameters:** * **path** – the output path * **pretty_print** – whether to render the JSON in human readable format with newlines and indentations. By default, this is False * **\*\*kwargs** – optional keyword arguments for `self.serialize()` ### *class* fiftyone.brain.internal.models.torch.TorchImageModel(config) Bases: [`TorchImageModel`](fiftyone.utils.torch.md#fiftyone.utils.torch.TorchImageModel) Wrapper for evaluating a Torch model on images whose state dict is stored privately by the Brain. * **Parameters:** **config** – an [`TorchImageModelConfig`](#fiftyone.brain.internal.models.torch.TorchImageModelConfig) **Methods:** | [`build_get_item`](#fiftyone.brain.internal.models.torch.TorchImageModel.build_get_item)([field_mapping]) | Builds the [`fiftyone.utils.torch.GetItem`](fiftyone.utils.torch.md#fiftyone.utils.torch.GetItem) instance that defines how the model's data should be loaded by data loaders. | |-------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [`collate_fn`](#fiftyone.brain.internal.models.torch.TorchImageModel.collate_fn)(batch) | The collate function to use when creating dataloaders for this model. | | [`embed`](#fiftyone.brain.internal.models.torch.TorchImageModel.embed)(arg) | Generates an embedding for the given data. | | [`embed_all`](#fiftyone.brain.internal.models.torch.TorchImageModel.embed_all)(args) | Generates embeddings for the given iterable of data. | | [`from_config`](#fiftyone.brain.internal.models.torch.TorchImageModel.from_config)(config) | Instantiates a Configurable class from a Config instance. | | [`from_dict`](#fiftyone.brain.internal.models.torch.TorchImageModel.from_dict)(d) | Instantiates a Configurable class from a Config dict. | | [`from_json`](#fiftyone.brain.internal.models.torch.TorchImageModel.from_json)(json_path) | Instantiates a Configurable class from a Config JSON file. | | [`from_kwargs`](#fiftyone.brain.internal.models.torch.TorchImageModel.from_kwargs)(\*\*kwargs) | Instantiates a Configurable class from keyword arguments defining the attributes of a Config. | | [`get_embeddings`](#fiftyone.brain.internal.models.torch.TorchImageModel.get_embeddings)() | Returns the embeddings generated by the last forward pass of the model. | | [`parse`](#fiftyone.brain.internal.models.torch.TorchImageModel.parse)(class_name[, module_name]) | Parses a Configurable subclass name string. | | [`predict`](#fiftyone.brain.internal.models.torch.TorchImageModel.predict)(img) | Performs prediction on the given image. | | [`predict_all`](#fiftyone.brain.internal.models.torch.TorchImageModel.predict_all)(imgs) | Performs prediction on the given batch of images. | | [`validate`](#fiftyone.brain.internal.models.torch.TorchImageModel.validate)(config) | Validates that the given config is an instance of Config. | **Attributes:** | [`can_embed_prompts`](#fiftyone.brain.internal.models.torch.TorchImageModel.can_embed_prompts) | Whether this model can generate prompt embeddings. | |------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------| | [`classes`](#fiftyone.brain.internal.models.torch.TorchImageModel.classes) | The list of class labels for the model, if known. | | [`device`](#fiftyone.brain.internal.models.torch.TorchImageModel.device) | The `torch:torch.torch.device` that the model is using. | | [`has_collate_fn`](#fiftyone.brain.internal.models.torch.TorchImageModel.has_collate_fn) | Whether this model has a custom collate function. | | [`has_embeddings`](#fiftyone.brain.internal.models.torch.TorchImageModel.has_embeddings) | Whether this model has embeddings. | | [`has_logits`](#fiftyone.brain.internal.models.torch.TorchImageModel.has_logits) | Whether this instance can generate logits. | | [`mask_targets`](#fiftyone.brain.internal.models.torch.TorchImageModel.mask_targets) | The mask targets for the model, if any. | | [`media_type`](#fiftyone.brain.internal.models.torch.TorchImageModel.media_type) | The media type processed by the model. | | [`num_classes`](#fiftyone.brain.internal.models.torch.TorchImageModel.num_classes) | The number of classes for the model, if known. | | [`preprocess`](#fiftyone.brain.internal.models.torch.TorchImageModel.preprocess) | Whether to apply preprocessing transforms for inference, if any. | | [`ragged_batches`](#fiftyone.brain.internal.models.torch.TorchImageModel.ragged_batches) | Whether [`transforms()`](#fiftyone.brain.internal.models.torch.TorchImageModel.transforms) may return tensors of different sizes. | | [`required_keys`](#fiftyone.brain.internal.models.torch.TorchImageModel.required_keys) | The required keys that must be provided as parameters to methods like `apply_model()` and `compute_embeddings()` at runtime. | | [`skeleton`](#fiftyone.brain.internal.models.torch.TorchImageModel.skeleton) | The keypoint skeleton for the model, if any. | | [`store_logits`](#fiftyone.brain.internal.models.torch.TorchImageModel.store_logits) | Whether the model should store logits in its predictions. | | [`transforms`](#fiftyone.brain.internal.models.torch.TorchImageModel.transforms) | A `torchvision.transforms` function that will be applied to each input before prediction, if any. | | [`using_gpu`](#fiftyone.brain.internal.models.torch.TorchImageModel.using_gpu) | Whether the model is using GPU. | | [`using_half_precision`](#fiftyone.brain.internal.models.torch.TorchImageModel.using_half_precision) | Whether the model is using half precision. | #### build_get_item(field_mapping=None) Builds the [`fiftyone.utils.torch.GetItem`](fiftyone.utils.torch.md#fiftyone.utils.torch.GetItem) instance that defines how the model’s data should be loaded by data loaders. * **Parameters:** **field_mapping** (*None*) – a user-provided dict mapping required keys to dataset field names * **Returns:** a [`fiftyone.utils.torch.GetItem`](fiftyone.utils.torch.md#fiftyone.utils.torch.GetItem) instance #### *property* can_embed_prompts Whether this model can generate prompt embeddings. This method returns `False` by default. Models that can generate prompt embeddings should override this via implementing the `PromptMixin` interface. #### *property* classes The list of class labels for the model, if known. #### *static* collate_fn(batch) The collate function to use when creating dataloaders for this model. In order to enable this functionality, the model’s [`has_collate_fn()`](#fiftyone.brain.internal.models.torch.TorchImageModel.has_collate_fn) property must return `True`. By default, this is the default collate function for [`torch.utils.data.DataLoader`](https://docs.pytorch.org/docs/stable/data.html#torch.utils.data.DataLoader), but subclasses can override this method as necessary. Note that this function must be serializable so it is compatible with multiprocessing for dataloaders. * **Parameters:** **batch** – a list of items to collate * **Returns:** the collated batch, which will be fed directly to the model #### *property* device The `torch:torch.torch.device` that the model is using. #### embed(arg) Generates an embedding for the given data. Subclasses can override this method to increase efficiency, but, by default, this method simply calls [`predict()`](#fiftyone.brain.internal.models.torch.TorchImageModel.predict) and then returns [`get_embeddings()`](#fiftyone.brain.internal.models.torch.TorchImageModel.get_embeddings). * **Parameters:** **arg** – the data. See [`predict()`](#fiftyone.brain.internal.models.torch.TorchImageModel.predict) for details * **Returns:** a numpy array containing the embedding #### embed_all(args) Generates embeddings for the given iterable of data. Subclasses can override this method to increase efficiency, but, by default, this method simply iterates over the data and applies [`embed()`](#fiftyone.brain.internal.models.torch.TorchImageModel.embed) to each. * **Parameters:** **args** – an iterable of data. See [`predict_all()`](#fiftyone.brain.internal.models.torch.TorchImageModel.predict_all) for details * **Returns:** a numpy array containing the embeddings stacked along axis 0 #### *classmethod* from_config(config) Instantiates a Configurable class from a Config instance. #### *classmethod* from_dict(d) Instantiates a Configurable class from a Config dict. * **Parameters:** **d** – a dict to construct a Config * **Returns:** an instance of cls #### *classmethod* from_json(json_path) Instantiates a Configurable class from a Config JSON file. * **Parameters:** **json_path** – path to a JSON file for type Config * **Returns:** an instance of cls #### *classmethod* from_kwargs(\*\*kwargs) Instantiates a Configurable class from keyword arguments defining the attributes of a Config. * **Parameters:** **\*\*kwargs** – keyword arguments that define the fields of a Config dict * **Returns:** an instance of cls #### get_embeddings() Returns the embeddings generated by the last forward pass of the model. By convention, this method should always return an array whose first axis represents batch size (which will always be 1 when [`predict()`](#fiftyone.brain.internal.models.torch.TorchImageModel.predict) was last used). * **Returns:** a numpy array containing the embedding(s) #### *property* has_collate_fn Whether this model has a custom collate function. Set this to `True` if you want [`collate_fn()`](#fiftyone.brain.internal.models.torch.TorchImageModel.collate_fn) to be used during inference. #### *property* has_embeddings Whether this model has embeddings. #### *property* has_logits Whether this instance can generate logits. #### *property* mask_targets The mask targets for the model, if any. #### *property* media_type The media type processed by the model. #### *property* num_classes The number of classes for the model, if known. #### *static* parse(class_name, module_name=None) Parses a Configurable subclass name string. Assumes both the Configurable class and the Config class are defined in the same module. The module containing the classes will be loaded if necessary. * **Parameters:** * **class_name** – a string containing the name of the Configurable class, e.g. “ClassName”, or a fully-qualified class name, e.g. “eta.core.config.ClassName” * **module_name** – a string containing the fully-qualified module name, e.g. “eta.core.config”, or None if class_name includes the module name. Set module_name = \_\_name_\_ to load a class from the calling module * **Returns:** the Configurable class config_cls: the Config class associated with cls * **Return type:** [cls](fiftyone.brain.internal.core.elasticsearch.md#fiftyone.brain.internal.core.elasticsearch.ElasticsearchSimilarityConfig.cls) #### predict(img) Performs prediction on the given image. * **Parameters:** **img** – the image to process, which can be any of the following: - A PIL image - A uint8 numpy array (HWC) - A Torch tensor (CHW) * **Returns:** a [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instance or dict of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances containing the predictions #### predict_all(imgs) Performs prediction on the given batch of images. * **Parameters:** **imgs** – the batch of images to process, which can be any of the following: - A list of PIL images - A list of uint8 numpy arrays (HWC) - A list of Torch tensors (CHW) - A uint8 numpy tensor (NHWC) - A Torch tensor (NCHW) * **Returns:** a list of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances or a list of dicts of [`fiftyone.core.labels.Label`](fiftyone.core.labels.md#fiftyone.core.labels.Label) instances containing the predictions #### *property* preprocess Whether to apply preprocessing transforms for inference, if any. #### *property* ragged_batches Whether [`transforms()`](#fiftyone.brain.internal.models.torch.TorchImageModel.transforms) may return tensors of different sizes. If True, then passing ragged lists of images to [`predict_all()`](#fiftyone.brain.internal.models.torch.TorchImageModel.predict_all) may not be not allowed. #### *property* required_keys The required keys that must be provided as parameters to methods like `apply_model()` and `compute_embeddings()` at runtime. #### *property* skeleton The keypoint skeleton for the model, if any. #### *property* store_logits Whether the model should store logits in its predictions. #### *property* transforms A `torchvision.transforms` function that will be applied to each input before prediction, if any. #### *property* using_gpu Whether the model is using GPU. #### *property* using_half_precision Whether the model is using half precision. #### *classmethod* validate(config) Validates that the given config is an instance of Config. * **Raises:** **ConfigurableError** – if config is not an instance of Config