<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/google-ai-edge/mediapipe/blob/master/mediapipe/tasks/python/vision/image_embedder.py#L134-L195) |

Options for the image embedder task.

    mp.tasks.vision.ImageEmbedderOptions(
        base_options: https://developers.google.com/edge/api/mediapipe/python/mp/tasks/BaseOptions,
        running_mode: https://developers.google.com/edge/api/mediapipe/python/mp/tasks/vision/RunningMode = https://developers.google.com/edge/api/mediapipe/python/mp/tasks/vision/FaceDetectorOptions#running_mode,
        l2_normalize: Optional[bool] = None,
        quantize: Optional[bool] = None,
        result_callback: Optional[Callable[[ImageEmbedderResult, image_module.Image, int], None]] = None,
        _result_callback_c: Optional[Callable[[ctypes.c_int32, ctypes.c_void_p, ctypes.c_void_p, ctypes
            .c_int64], None]] = None
    )

<br />

<br />

<br />

| ## Attributes ||
|---|---|
| `base_options` | Base options for the image embedder task. |
| `running_mode` | The running mode of the task. Default to the image mode. Image embedder task has three running modes: 1) The image mode for embedding image on single image inputs. 2) The video mode for embedding image on the decoded frames of a video. 3) The live stream mode for embedding image on a live stream of input data, such as from camera. |
| `l2_normalize` | Whether to normalize the returned feature vector with L2 norm. Use this option only if the model does not already contain a native L2_NORMALIZATION TF Lite Op. In most cases, this is already the case and L2 norm is thus achieved through TF Lite inference. |
| `quantize` | Whether the returned embedding should be quantized to bytes via scalar quantization. Embeddings are implicitly assumed to be unit-norm and therefore any dimension is guaranteed to have a value in \[-1.0, 1.0\]. Use the l2_normalize option if this is not the case. |
| `result_callback` | The user-defined result callback for processing live stream data. The result callback should only be specified when the running mode is set to the live stream mode. |

<br />

## Methods

### `to_ctypes`

[View source](https://github.com/google-ai-edge/mediapipe/blob/master/mediapipe/tasks/python/vision/image_embedder.py#L178-L195)

    to_ctypes(
        dispatcher: async_result_dispatcher.AsyncResultDispatcher
    ) -> MpImageEmbedderOptionsC

Generates an MpImageEmbedderOptionsC object.

### `__eq__`

    __eq__(
        other
    )

Return self==value.

<br />

<br />

<br />

| ## Class Variables ||
|---|---|
| l2_normalize | `None` |
| quantize | `None` |
| result_callback | `None` |
| running_mode | `<VisionTaskRunningMode.IMAGE: 'IMAGE'>` |

<br />