haystack/test/nodes/test_image_to_text.py
Stefano Fiorucci b910df7ec7
feat: ImageToText (caption generator) (#3859)
* first draft

* fix pylint and mypy

* retry w mypy

* mypy :-)

* rem unused import

* incorporate feedback and initial tests

* better tests

* fix import order

* fix docstring

* other fix docstring

* more and better tests

Co-authored-by: ZanSara <sarazanzo94@gmail.com>
2023-01-23 11:59:56 +01:00

90 lines
3.3 KiB
Python

import os
import pytest
from haystack import Document
from haystack.nodes.image_to_text.transformers import TransformersImageToText
from haystack.nodes.image_to_text.base import BaseImageToText
from haystack.errors import ImageToTextError
from ..conftest import SAMPLES_PATH
IMAGE_FILE_NAMES = ["apple.jpg", "car.jpg", "cat.jpg", "galaxy.jpg", "paris.jpg"]
IMAGE_FILE_PATHS = [os.path.join(SAMPLES_PATH, "images", file_name) for file_name in IMAGE_FILE_NAMES]
IMAGE_DOCS = [Document(content=image_path, content_type="image") for image_path in IMAGE_FILE_PATHS]
EXPECTED_CAPTIONS = [
"a red apple is sitting on a pile of hay",
"a white car parked in a parking lot",
"a cat laying in the grass",
"a blurry photo of a blurry shot of a black object",
"a city with a large building and a clock tower",
]
@pytest.fixture
def image_to_text():
return TransformersImageToText(
model_name_or_path="nlpconnect/vit-gpt2-image-captioning",
devices=["cpu"],
generation_kwargs={"max_new_tokens": 50},
)
@pytest.mark.integration
def test_image_to_text_from_files(image_to_text):
assert isinstance(image_to_text, BaseImageToText)
results = image_to_text.run(file_paths=IMAGE_FILE_PATHS)
image_paths = [doc.meta["image_path"] for doc in results[0]["documents"]]
assert image_paths == IMAGE_FILE_PATHS
generated_captions = [doc.content for doc in results[0]["documents"]]
assert generated_captions == EXPECTED_CAPTIONS
@pytest.mark.integration
def test_image_to_text_from_documents(image_to_text):
results = image_to_text.run(documents=IMAGE_DOCS)
image_paths = [doc.meta["image_path"] for doc in results[0]["documents"]]
assert image_paths == IMAGE_FILE_PATHS
generated_captions = [doc.content for doc in results[0]["documents"]]
assert generated_captions == EXPECTED_CAPTIONS
@pytest.mark.integration
def test_image_to_text_from_files_and_documents(image_to_text):
results = image_to_text.run(file_paths=IMAGE_FILE_PATHS[:3], documents=IMAGE_DOCS[3:])
image_paths = [doc.meta["image_path"] for doc in results[0]["documents"]]
assert image_paths == IMAGE_FILE_PATHS
generated_captions = [doc.content for doc in results[0]["documents"]]
assert generated_captions == EXPECTED_CAPTIONS
@pytest.mark.integration
def test_image_to_text_invalid_image(image_to_text):
markdown_path = str(SAMPLES_PATH / "markdown" / "sample.md")
with pytest.raises(ImageToTextError, match="cannot identify image file"):
image_to_text.run(file_paths=[markdown_path])
@pytest.mark.integration
def test_image_to_text_incorrect_path(image_to_text):
with pytest.raises(ImageToTextError, match="Incorrect path"):
image_to_text.run(file_paths=["wrong_path.jpg"])
@pytest.mark.integration
def test_image_to_text_not_image_document(image_to_text):
textual_document = Document(content="this document is textual", content_type="text")
with pytest.raises(ValueError, match="The ImageToText node only supports image documents."):
image_to_text.run(documents=[textual_document])
@pytest.mark.integration
def test_image_to_text_unsupported_model():
with pytest.raises(
ValueError, match="The model of class 'BertForQuestionAnswering' is not supported for ImageToText"
):
_ = TransformersImageToText(model_name_or_path="deepset/minilm-uncased-squad2")