From 30ffc647e787d67e44c88b9c1683c5d7720d2ea8 Mon Sep 17 00:00:00 2001 From: anakin87 Date: Thu, 23 Jan 2025 15:54:25 +0100 Subject: [PATCH 1/3] fix: Document Classifiers - fix docstrings + error messages --- .../components/classifiers/document_language_classifier.py | 2 +- .../components/classifiers/zero_shot_document_classifier.py | 4 ++-- ...fix-classifiers-docstrings-messages-dcae473d2bd3cb95.yaml | 5 +++++ 3 files changed, 8 insertions(+), 3 deletions(-) create mode 100644 releasenotes/notes/fix-classifiers-docstrings-messages-dcae473d2bd3cb95.yaml diff --git a/haystack/components/classifiers/document_language_classifier.py b/haystack/components/classifiers/document_language_classifier.py index ed9b42b5d5..5b6b3469bc 100644 --- a/haystack/components/classifiers/document_language_classifier.py +++ b/haystack/components/classifiers/document_language_classifier.py @@ -83,7 +83,7 @@ def run(self, documents: List[Document]): if not isinstance(documents, list) or documents and not isinstance(documents[0], Document): raise TypeError( "DocumentLanguageClassifier expects a list of Document as input. " - "In case you want to classify a text, please use the TextLanguageClassifier." + "In case you want to classify and route a text, please use the TextLanguageRouter." ) output: Dict[str, List[Document]] = {language: [] for language in self.languages} diff --git a/haystack/components/classifiers/zero_shot_document_classifier.py b/haystack/components/classifiers/zero_shot_document_classifier.py index 4be0a66d44..017a20f3c5 100644 --- a/haystack/components/classifiers/zero_shot_document_classifier.py +++ b/haystack/components/classifiers/zero_shot_document_classifier.py @@ -211,8 +211,8 @@ def run(self, documents: List[Document], batch_size: int = 1): if not isinstance(documents, list) or documents and not isinstance(documents[0], Document): raise TypeError( - "DocumentLanguageClassifier expects a list of documents as input. " - "In case you want to classify a text, please use the TextLanguageClassifier." + "TransformerZeroShotDocumentClassifier expects a list of documents as input. " + "In case you want to classify and route a text, please use the TransformersZeroShotTextRouter." ) invalid_doc_ids = [] diff --git a/releasenotes/notes/fix-classifiers-docstrings-messages-dcae473d2bd3cb95.yaml b/releasenotes/notes/fix-classifiers-docstrings-messages-dcae473d2bd3cb95.yaml new file mode 100644 index 0000000000..d303bf68d8 --- /dev/null +++ b/releasenotes/notes/fix-classifiers-docstrings-messages-dcae473d2bd3cb95.yaml @@ -0,0 +1,5 @@ +--- +fixes: + - | + Fix docstrings and error messages for Document Classifier components, that were suggesting to use inexistent + components for text classification. From afd0d2b632fe606dfd6255e906f8ac0802491c17 Mon Sep 17 00:00:00 2001 From: anakin87 Date: Thu, 23 Jan 2025 15:57:36 +0100 Subject: [PATCH 2/3] grammar --- .../fix-classifiers-docstrings-messages-dcae473d2bd3cb95.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/releasenotes/notes/fix-classifiers-docstrings-messages-dcae473d2bd3cb95.yaml b/releasenotes/notes/fix-classifiers-docstrings-messages-dcae473d2bd3cb95.yaml index d303bf68d8..9fc591f950 100644 --- a/releasenotes/notes/fix-classifiers-docstrings-messages-dcae473d2bd3cb95.yaml +++ b/releasenotes/notes/fix-classifiers-docstrings-messages-dcae473d2bd3cb95.yaml @@ -1,5 +1,5 @@ --- fixes: - | - Fix docstrings and error messages for Document Classifier components, that were suggesting to use inexistent + Fix docstrings and error messages for Document Classifier components, that suggested using nonexistent components for text classification. From 2655e9a9d4c40379e291e16c281e87ec814c5f2e Mon Sep 17 00:00:00 2001 From: anakin87 Date: Thu, 23 Jan 2025 15:59:18 +0100 Subject: [PATCH 3/3] fix --- .../fix-classifiers-docstrings-messages-dcae473d2bd3cb95.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/releasenotes/notes/fix-classifiers-docstrings-messages-dcae473d2bd3cb95.yaml b/releasenotes/notes/fix-classifiers-docstrings-messages-dcae473d2bd3cb95.yaml index 9fc591f950..32d36192ff 100644 --- a/releasenotes/notes/fix-classifiers-docstrings-messages-dcae473d2bd3cb95.yaml +++ b/releasenotes/notes/fix-classifiers-docstrings-messages-dcae473d2bd3cb95.yaml @@ -1,5 +1,5 @@ --- fixes: - | - Fix docstrings and error messages for Document Classifier components, that suggested using nonexistent - components for text classification. + Fix error messages for Document Classifier components, that suggested using nonexistent components for text + classification.