Skip to content

Fix: Add Image.Image support to encode() overloads to resolve mypy error (#3462) #3485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+9 −8
Open

Fix: Add Image.Image support to encode() overloads to resolve mypy error (#3462) #3485

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions sentence_transformers/SentenceTransformer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@

import numpy as np
import numpy.typing as npt
from PIL import Image
import torch
import torch.multiprocessing as mp
import transformers
Expand Down Expand Up @@ -678,7 +679,7 @@ def encode_document(
@overload
def encode(
self,
sentences: str,
sentences: str | Image.Image,
prompt_name: str | None = ...,
prompt: str | None = ...,
batch_size: int = ...,
Expand All @@ -700,7 +701,7 @@ def encode(
@overload
def encode(
self,
sentences: str | list[str] | np.ndarray,
sentences: str | list[str] | np.ndarray | Image.Image | list[Image.Image],
prompt_name: str | None = ...,
prompt: str | None = ...,
batch_size: int = ...,
Expand All @@ -722,7 +723,7 @@ def encode(
@overload
def encode(
self,
sentences: str | list[str] | np.ndarray,
sentences: str | list[str] | np.ndarray | Image.Image | list[Image.Image],
prompt_name: str | None = ...,
prompt: str | None = ...,
batch_size: int = ...,
Expand All @@ -743,7 +744,7 @@ def encode(
@overload
def encode(
self,
sentences: list[str] | np.ndarray,
sentences: list[str] | np.ndarray | list[Image.Image],
prompt_name: str | None = ...,
prompt: str | None = ...,
batch_size: int = ...,
Expand All @@ -764,7 +765,7 @@ def encode(
@overload
def encode(
self,
sentences: list[str] | np.ndarray,
sentences: list[str] | np.ndarray | list[Image.Image],
prompt_name: str | None = ...,
prompt: str | None = ...,
batch_size: int = ...,
Expand All @@ -785,7 +786,7 @@ def encode(
@overload
def encode(
self,
sentences: str,
sentences: str | Image.Image,
prompt_name: str | None = ...,
prompt: str | None = ...,
batch_size: int = ...,
Expand All @@ -806,7 +807,7 @@ def encode(
@overload
def encode(
self,
sentences: str,
sentences: str | Image.Image,
prompt_name: str | None = ...,
prompt: str | None = ...,
batch_size: int = ...,
Expand All @@ -826,7 +827,7 @@ def encode(
@torch.inference_mode()
def encode(
self,
sentences: str | list[str] | np.ndarray,
sentences: str | list[str] | np.ndarray | Image.Image | list[Image.Image],
prompt_name: str | None = None,
prompt: str | None = None,
batch_size: int = 32,
Expand Down
Loading