transformers/tests/pipelines
Nicolas Patry 8e777b3ba4
[Proposal] Breaking change zero-shot-object-detection for improved consistency. (#20280)
* [Proposal] Breaking change `zero-shot-object-detection` for improved
consistency.

This is a proposal to modify the output of `zero-shot-object-detection`
to provide better alignment with other pipelines.

The output is now strictly the same as `object-detection` whereas before
it would output lists of lists.

The name `candidate_labels` is used throughout for consistency with
other `zero-shot` pipelines.

The pipeline is changed to `ChunkPipeline` to support batching cleanly.

This removes all the lists and list of lists shenanigans, it's now a
matter of the base pipeline handling all this not this specific one.

**Breaking change**: It did remove complex calls potentials `pipe(images = [image1, image2],
text_queries=[candidates1, candidates2])` to support only
`pipe([{"image": image1, "candidate_labels": candidates1}, {"image": image2, "candidate_labels": candidates2}])`
when dealing with lists and/or datasets.
We could keep them, but it will add a lot of complexity to the code
base, since the pipeline is rather young, I'd rather break to keep the
code simpler, but we can revert this.

**Breaking change**: The name of the argument is now `image` instead of
`images` since it expects by default only 1 image. This is revertable
like the previous one.

**Breaking change**: The types is now simplified and flattened:

`pipe(inputs) == [{**object1}, {**object2}]`
instead of the previous
`pipe(inputs) == [[{**object1}, {**object1}], [{**object2}]]`
Where the different instances would be grouped by candidate labels
within lists.
IMHO this is not really desirable, since it would output empty lists and
is only adding superflous indirection compared to
`zero-shot-object-detection`.

It is relatively change free in terms of how the results, it does change
computation however since now the batching is handled by the pipeline
itself. It **did** change the results for the small models so there
seems to be a real difference in how the models handle this.

* Fixing the doctests.

* Behind is_torch_available.
2022-11-18 15:57:28 +01:00
..
__init__.py [Test refactor 1/5] Per-folder tests reorganization (#15725) 2022-02-23 15:46:28 -05:00
test_pipelines_audio_classification.py Rework pipeline tests (#19366) 2022-10-07 18:01:58 -04:00
test_pipelines_automatic_speech_recognition.py Adding chunking for whisper (all seq2seq actually). Very crude matching algorithm. (#20104) 2022-11-14 22:32:50 +01:00
test_pipelines_common.py Fix tapas scatter (#20149) 2022-11-14 01:04:26 -05:00
test_pipelines_conversational.py Rework pipeline tests (#19366) 2022-10-07 18:01:58 -04:00
test_pipelines_depth_estimation.py Add depth estimation pipeline (#18618) 2022-10-12 08:54:20 -04:00
test_pipelines_document_question_answering.py A few CI fixes for DocumentQuestionAnsweringPipeline (#19584) 2022-10-17 15:35:27 +02:00
test_pipelines_feature_extraction.py add return_tensors parameter for feature_extraction 2 (#19707) 2022-10-18 16:29:00 +02:00
test_pipelines_fill_mask.py Rework pipeline tests (#19366) 2022-10-07 18:01:58 -04:00
test_pipelines_image_classification.py Specify TF framework explicitly in more pipeline tests (#19748) 2022-10-19 16:24:03 +02:00
test_pipelines_image_segmentation.py Make ImageSegmentationPipelineTests less flaky (#20147) 2022-11-15 09:14:55 +01:00
test_pipelines_image_to_text.py fix image2test args forwarding (#19648) 2022-10-24 09:49:24 -04:00
test_pipelines_object_detection.py Adding support for LayoutLMvX variants for object-detection. (#20143) 2022-11-10 11:33:38 +01:00
test_pipelines_question_answering.py Clean up deprecation warnings (#19654) 2022-10-18 13:34:47 -04:00
test_pipelines_summarization.py Add Switch transformers (#19323) 2022-11-15 13:06:45 +01:00
test_pipelines_table_question_answering.py Fix tapas scatter (#20149) 2022-11-14 01:04:26 -05:00
test_pipelines_text_classification.py Rework pipeline tests (#19366) 2022-10-07 18:01:58 -04:00
test_pipelines_text_generation.py Rework pipeline tests (#19366) 2022-10-07 18:01:58 -04:00
test_pipelines_text2text_generation.py Rework pipeline tests (#19366) 2022-10-07 18:01:58 -04:00
test_pipelines_token_classification.py TF port of ESM (#19587) 2022-10-17 14:16:16 +01:00
test_pipelines_translation.py Rework pipeline tests (#19366) 2022-10-07 18:01:58 -04:00
test_pipelines_visual_question_answering.py Rework pipeline tests (#19366) 2022-10-07 18:01:58 -04:00
test_pipelines_zero_shot_image_classification.py Rework pipeline tests (#19366) 2022-10-07 18:01:58 -04:00
test_pipelines_zero_shot_object_detection.py [Proposal] Breaking change zero-shot-object-detection for improved consistency. (#20280) 2022-11-18 15:57:28 +01:00
test_pipelines_zero_shot.py Rework pipeline tests (#19366) 2022-10-07 18:01:58 -04:00