From 99cb95a63ad7b3760453a71e4d0ff7fa4670126d Mon Sep 17 00:00:00 2001 From: Daria Fokina Date: Mon, 7 Aug 2023 12:21:25 +0200 Subject: [PATCH] docs: separate abstract classes into separate API references (#5501) * separate_abstractions * img-to-text parent slug upd * Apply suggestions from code review Co-authored-by: Massimiliano Pippi --------- Co-authored-by: Massimiliano Pippi --- docs/pydoc/config/answer-generator.yml | 2 +- docs/pydoc/config/base-converter.yml | 27 ++++++++++++++++++ .../config/base-doc-language-classifier.yml | 27 ++++++++++++++++++ .../pydoc/config/base-document-classifier.yml | 28 +++++++++++++++++++ docs/pydoc/config/base-document-store.yml | 27 ++++++++++++++++++ docs/pydoc/config/base-generator.yml | 27 ++++++++++++++++++ docs/pydoc/config/base-image-to-text.yml | 28 +++++++++++++++++++ docs/pydoc/config/base-preprocessor.yml | 28 +++++++++++++++++++ docs/pydoc/config/base-query-classifier.yml | 28 +++++++++++++++++++ docs/pydoc/config/base-ranker.yml | 27 ++++++++++++++++++ docs/pydoc/config/base-reader.yml | 28 +++++++++++++++++++ docs/pydoc/config/base-retriever.yml | 27 ++++++++++++++++++ docs/pydoc/config/base-summarizer.yml | 27 ++++++++++++++++++ docs/pydoc/config/base-translator.yml | 28 +++++++++++++++++++ docs/pydoc/config/doc-language-classifier.yml | 2 +- docs/pydoc/config/document-classifier.yml | 2 +- docs/pydoc/config/document-store.yml | 1 - docs/pydoc/config/file-converters.yml | 1 - docs/pydoc/config/preprocessor.yml | 2 +- docs/pydoc/config/query-classifier.yml | 2 +- docs/pydoc/config/ranker.yml | 2 +- docs/pydoc/config/reader.yml | 2 +- docs/pydoc/config/retriever.yml | 2 +- docs/pydoc/config/summarizer.yml | 2 +- .../pydoc/config/transformers-img-to-text.yml | 2 +- docs/pydoc/config/translator.yml | 2 +- 26 files changed, 368 insertions(+), 13 deletions(-) create mode 100644 docs/pydoc/config/base-converter.yml create mode 100644 docs/pydoc/config/base-doc-language-classifier.yml create mode 100644 docs/pydoc/config/base-document-classifier.yml create mode 100644 docs/pydoc/config/base-document-store.yml create mode 100644 docs/pydoc/config/base-generator.yml create mode 100644 docs/pydoc/config/base-image-to-text.yml create mode 100644 docs/pydoc/config/base-preprocessor.yml create mode 100644 docs/pydoc/config/base-query-classifier.yml create mode 100644 docs/pydoc/config/base-ranker.yml create mode 100644 docs/pydoc/config/base-reader.yml create mode 100644 docs/pydoc/config/base-retriever.yml create mode 100644 docs/pydoc/config/base-summarizer.yml create mode 100644 docs/pydoc/config/base-translator.yml diff --git a/docs/pydoc/config/answer-generator.yml b/docs/pydoc/config/answer-generator.yml index 695ad38e4..285c2d067 100644 --- a/docs/pydoc/config/answer-generator.yml +++ b/docs/pydoc/config/answer-generator.yml @@ -1,7 +1,7 @@ loaders: - type: loaders.CustomPythonLoader search_path: [../../../haystack/nodes/answer_generator] - modules: ["base", "openai"] + modules: ["openai"] ignore_when_discovered: ["__init__"] processors: - type: filter diff --git a/docs/pydoc/config/base-converter.yml b/docs/pydoc/config/base-converter.yml new file mode 100644 index 000000000..cd2dc0407 --- /dev/null +++ b/docs/pydoc/config/base-converter.yml @@ -0,0 +1,27 @@ +loaders: + - type: python + search_path: [../../../haystack/nodes/file_converter] + modules: ["base"] + ignore_when_discovered: ["__init__"] +processors: + - type: filter + expression: + documented_only: true + do_not_filter_modules: false + skip_empty_modules: true + - type: smart + - type: crossref +renderer: + type: renderers.ReadmeRenderer + excerpt: Abstract class for implementing file converters. + category_slug: haystack-classes + title: Base Converters API + slug: base-converters-api + order: 72 + parent_doc_slug: file-converters-api + markdown: + descriptive_class_title: false + descriptive_module_title: true + add_method_class_prefix: true + add_member_class_prefix: false + filename: base_converters_api.md diff --git a/docs/pydoc/config/base-doc-language-classifier.yml b/docs/pydoc/config/base-doc-language-classifier.yml new file mode 100644 index 000000000..8db7b399b --- /dev/null +++ b/docs/pydoc/config/base-doc-language-classifier.yml @@ -0,0 +1,27 @@ +loaders: + - type: python + search_path: [../../../haystack/nodes/doc_language_classifier] + modules: ["base"] + ignore_when_discovered: ["__init__"] +processors: + - type: filter + expression: + documented_only: true + do_not_filter_modules: false + skip_empty_modules: true + - type: smart + - type: crossref +renderer: + type: renderers.ReadmeRenderer + excerpt: Abstract class for Document Language Classifiers. + category_slug: haystack-classes + title: Base Document Language Classifier API + slug: base-doc-language-classifier-api + order: 27 + parent_doc_slug: doc-language-classifier-api + markdown: + descriptive_class_title: false + descriptive_module_title: true + add_method_class_prefix: true + add_member_class_prefix: false + filename: base_doc_language_classifier_api.md diff --git a/docs/pydoc/config/base-document-classifier.yml b/docs/pydoc/config/base-document-classifier.yml new file mode 100644 index 000000000..40e3f9276 --- /dev/null +++ b/docs/pydoc/config/base-document-classifier.yml @@ -0,0 +1,28 @@ +loaders: + - type: python + search_path: [../../../haystack/nodes/document_classifier] + modules: ["base"] + ignore_when_discovered: ["__init__"] +processors: + - type: filter + expression: + documented_only: true + do_not_filter_modules: false + skip_empty_modules: true + - type: smart + - type: crossref +renderer: + type: renderers.ReadmeRenderer + excerpt: Abstract class for the Document Classifer. + category_slug: haystack-classes + title: Base Document Classifier API + slug: base-document-classifier-api + order: 22 + parent_doc_slug: document-classifier-api + markdown: + descriptive_class_title: false + descriptive_module_title: true + add_method_class_prefix: true + add_member_class_prefix: false + filename: base_document_classifier_api.md + diff --git a/docs/pydoc/config/base-document-store.yml b/docs/pydoc/config/base-document-store.yml new file mode 100644 index 000000000..32c045fcc --- /dev/null +++ b/docs/pydoc/config/base-document-store.yml @@ -0,0 +1,27 @@ +loaders: + - type: python + search_path: [../../../haystack/document_stores] + modules: ["base"] + ignore_when_discovered: ["__init__"] +processors: + - type: filter + expression: + documented_only: true + do_not_filter_modules: false + skip_empty_modules: true + - type: smart + - type: crossref +renderer: + type: renderers.ReadmeRenderer + excerpt: Abstract classes for the Document Stores and Keyword Document Stores. + category_slug: haystack-classes + title: Base Document Store API + slug: base-document-store-api + order: 32 + parent_doc_slug: document-store-api + markdown: + descriptive_class_title: false + descriptive_module_title: true + add_method_class_prefix: true + add_member_class_prefix: false + filename: base_document_store_api.md diff --git a/docs/pydoc/config/base-generator.yml b/docs/pydoc/config/base-generator.yml new file mode 100644 index 000000000..41d8fd890 --- /dev/null +++ b/docs/pydoc/config/base-generator.yml @@ -0,0 +1,27 @@ +loaders: + - type: python + search_path: [../../../haystack/nodes/answer_generator] + modules: ["base"] + ignore_when_discovered: ["__init__"] +processors: + - type: filter + expression: + documented_only: true + do_not_filter_modules: false + skip_empty_modules: true + - type: smart + - type: crossref +renderer: + type: renderers.ReadmeRenderer + excerpt: Abstract class for Generators. + category_slug: haystack-classes + title: BaseGenerator API + slug: basegenerator-api + order: 7 + parent_doc_slug: answer-generator-api + markdown: + descriptive_class_title: false + descriptive_module_title: true + add_method_class_prefix: true + add_member_class_prefix: false + filename: basegenerator_api.md diff --git a/docs/pydoc/config/base-image-to-text.yml b/docs/pydoc/config/base-image-to-text.yml new file mode 100644 index 000000000..4aff28b43 --- /dev/null +++ b/docs/pydoc/config/base-image-to-text.yml @@ -0,0 +1,28 @@ +loaders: + - type: python + search_path: [../../../haystack/nodes/image_to_text] + modules: ["base"] + ignore_when_discovered: ["__init__"] +processors: + - type: filter + expression: + documented_only: true + do_not_filter_modules: false + skip_empty_modules: true + - type: smart + - type: crossref +renderer: + type: renderers.ReadmeRenderer + excerpt: Abstract class for ImageToText. + category_slug: haystack-classes + title: BaseImageToText API + slug: base-image-to-text-api + order: 187 + parent_doc_slug: transformers-image-to-text-api + markdown: + descriptive_class_title: false + descriptive_module_title: true + add_method_class_prefix: true + add_member_class_prefix: false + filename: base-image-to-text.md + diff --git a/docs/pydoc/config/base-preprocessor.yml b/docs/pydoc/config/base-preprocessor.yml new file mode 100644 index 000000000..f22dfe134 --- /dev/null +++ b/docs/pydoc/config/base-preprocessor.yml @@ -0,0 +1,28 @@ +loaders: + - type: python + search_path: [../../../haystack/nodes/preprocessor] + modules: ["base"] + ignore_when_discovered: ["__init__"] +processors: + - type: filter + expression: + documented_only: true + do_not_filter_modules: false + skip_empty_modules: true + - type: smart + - type: crossref +renderer: + type: renderers.ReadmeRenderer + excerpt: Abstract class for the PreProcessor. + category_slug: haystack-classes + title: Base PreProcessor API + slug: base-preprocessor-api + order: 102 + parent_doc_slug: preprocessor-api + markdown: + descriptive_class_title: false + descriptive_module_title: true + add_method_class_prefix: true + add_member_class_prefix: false + filename: base_preprocessor_api.md + diff --git a/docs/pydoc/config/base-query-classifier.yml b/docs/pydoc/config/base-query-classifier.yml new file mode 100644 index 000000000..461f98fa5 --- /dev/null +++ b/docs/pydoc/config/base-query-classifier.yml @@ -0,0 +1,28 @@ +loaders: + - type: python + search_path: [../../../haystack/nodes/query_classifier] + modules: ["base"] + ignore_when_discovered: ["__init__"] +processors: + - type: filter + expression: + documented_only: true + do_not_filter_modules: false + skip_empty_modules: true + - type: smart + - type: crossref +renderer: + type: renderers.ReadmeRenderer + excerpt: Abstract class for Query Classifiers. + category_slug: haystack-classes + title: Base Query Classifier API + slug: base-query-classifier-api + order: 132 + parent_doc_slug: query-classifier-api + markdown: + descriptive_class_title: false + descriptive_module_title: true + add_method_class_prefix: true + add_member_class_prefix: false + filename: query_classifier_api.md + diff --git a/docs/pydoc/config/base-ranker.yml b/docs/pydoc/config/base-ranker.yml new file mode 100644 index 000000000..7b69105c2 --- /dev/null +++ b/docs/pydoc/config/base-ranker.yml @@ -0,0 +1,27 @@ +loaders: + - type: python + search_path: [../../../haystack/nodes/ranker] + modules: ["base"] + ignore_when_discovered: ["__init__"] +processors: + - type: filter + expression: + documented_only: true + do_not_filter_modules: false + skip_empty_modules: true + - type: smart + - type: crossref +renderer: + type: renderers.ReadmeRenderer + excerpt: Abstract class for Rankers. + category_slug: haystack-classes + title: Base Ranker API + slug: base-ranker-api + order: 152 + parent_doc_slug: ranker-api + markdown: + descriptive_class_title: false + descriptive_module_title: true + add_method_class_prefix: true + add_member_class_prefix: false + filename: base_ranker_api.md diff --git a/docs/pydoc/config/base-reader.yml b/docs/pydoc/config/base-reader.yml new file mode 100644 index 000000000..be1a1c3d9 --- /dev/null +++ b/docs/pydoc/config/base-reader.yml @@ -0,0 +1,28 @@ +loaders: + - type: python + search_path: [../../../haystack/nodes/reader] + modules: ["base"] + ignore_when_discovered: ["__init__"] +processors: + - type: filter + expression: + documented_only: true + do_not_filter_modules: false + skip_empty_modules: true + - type: smart + - type: crossref +renderer: + type: renderers.ReadmeRenderer + excerpt: Abstract class for Readers. + category_slug: haystack-classes + title: Base Reader API + slug: base-reader-api + order: 162 + parent_doc_slug: reader-api + markdown: + descriptive_class_title: false + descriptive_module_title: true + add_method_class_prefix: true + add_member_class_prefix: false + filename: base_reader_api.md + diff --git a/docs/pydoc/config/base-retriever.yml b/docs/pydoc/config/base-retriever.yml new file mode 100644 index 000000000..e1a2ed132 --- /dev/null +++ b/docs/pydoc/config/base-retriever.yml @@ -0,0 +1,27 @@ +loaders: + - type: python + search_path: [../../../haystack/nodes/retriever] + modules: ["base"] + ignore_when_discovered: ["__init__"] +processors: + - type: filter + expression: + documented_only: true + do_not_filter_modules: false + skip_empty_modules: true + - type: smart + - type: crossref +renderer: + type: renderers.ReadmeRenderer + excerpt: Abstract class for Retrievers. + category_slug: haystack-classes + title: Base Retriever API + slug: base-retriever-api + order: 172 + parent_doc_slug: retriever-api + markdown: + descriptive_class_title: false + descriptive_module_title: true + add_method_class_prefix: true + add_member_class_prefix: false + filename: base_retriever_api.md diff --git a/docs/pydoc/config/base-summarizer.yml b/docs/pydoc/config/base-summarizer.yml new file mode 100644 index 000000000..cb6e62e0b --- /dev/null +++ b/docs/pydoc/config/base-summarizer.yml @@ -0,0 +1,27 @@ +loaders: + - type: python + search_path: [../../../haystack/nodes/summarizer] + modules: ["base"] + ignore_when_discovered: ["__init__"] +processors: + - type: filter + expression: + documented_only: true + do_not_filter_modules: false + skip_empty_modules: true + - type: smart + - type: crossref +renderer: + type: renderers.ReadmeRenderer + excerpt: Abstract class for Summarizers. + category_slug: haystack-classes + title: Base Summarizer API + slug: base-summarizer-api + order: 182 + parent_doc_slug: summarizer-api + markdown: + descriptive_class_title: false + descriptive_module_title: true + add_method_class_prefix: true + add_member_class_prefix: false + filename: base_summarizer_api.md diff --git a/docs/pydoc/config/base-translator.yml b/docs/pydoc/config/base-translator.yml new file mode 100644 index 000000000..ee9c241b5 --- /dev/null +++ b/docs/pydoc/config/base-translator.yml @@ -0,0 +1,28 @@ +loaders: + - type: python + search_path: [../../../haystack/nodes/translator] + modules: ["base"] + ignore_when_discovered: ["__init__"] +processors: + - type: filter + expression: + documented_only: true + do_not_filter_modules: false + skip_empty_modules: true + - type: smart + - type: crossref +renderer: + type: renderers.ReadmeRenderer + excerpt: Abstract class for Translators. + category_slug: haystack-classes + title: Base Translator API + slug: base-translator-api + order: 192 + parent_doc_slug: translator-api + markdown: + descriptive_class_title: false + descriptive_module_title: true + add_method_class_prefix: true + add_member_class_prefix: false + filename: base_translator_api.md + diff --git a/docs/pydoc/config/doc-language-classifier.yml b/docs/pydoc/config/doc-language-classifier.yml index acdc7f939..e5b6eab7a 100644 --- a/docs/pydoc/config/doc-language-classifier.yml +++ b/docs/pydoc/config/doc-language-classifier.yml @@ -1,7 +1,7 @@ loaders: - type: loaders.CustomPythonLoader search_path: [../../../haystack/nodes/doc_language_classifier] - modules: ["base", "langdetect", "transformers"] + modules: ["langdetect", "transformers"] ignore_when_discovered: ["__init__"] processors: - type: filter diff --git a/docs/pydoc/config/document-classifier.yml b/docs/pydoc/config/document-classifier.yml index 97be9d655..0c0a46a55 100644 --- a/docs/pydoc/config/document-classifier.yml +++ b/docs/pydoc/config/document-classifier.yml @@ -1,7 +1,7 @@ loaders: - type: loaders.CustomPythonLoader search_path: [../../../haystack/nodes/document_classifier] - modules: ["base", "transformers"] + modules: ["transformers"] ignore_when_discovered: ["__init__"] processors: - type: filter diff --git a/docs/pydoc/config/document-store.yml b/docs/pydoc/config/document-store.yml index 31cd08a4c..4e39d54d3 100644 --- a/docs/pydoc/config/document-store.yml +++ b/docs/pydoc/config/document-store.yml @@ -3,7 +3,6 @@ loaders: search_path: [../../../haystack/document_stores, ../../../haystack/document_stores/elasticsearch] modules: [ - "base", "es7", "es8", "opensearch", diff --git a/docs/pydoc/config/file-converters.yml b/docs/pydoc/config/file-converters.yml index 6dbe1ec74..a3f8b6e02 100644 --- a/docs/pydoc/config/file-converters.yml +++ b/docs/pydoc/config/file-converters.yml @@ -3,7 +3,6 @@ loaders: search_path: [../../../haystack/nodes/file_converter] modules: [ - "base", "csv", "docx", "image", diff --git a/docs/pydoc/config/preprocessor.yml b/docs/pydoc/config/preprocessor.yml index f6a86113e..a1f006c8d 100644 --- a/docs/pydoc/config/preprocessor.yml +++ b/docs/pydoc/config/preprocessor.yml @@ -1,7 +1,7 @@ loaders: - type: loaders.CustomPythonLoader search_path: [../../../haystack/nodes/preprocessor] - modules: ["base", "preprocessor"] + modules: ["preprocessor"] ignore_when_discovered: ["__init__"] processors: - type: filter diff --git a/docs/pydoc/config/query-classifier.yml b/docs/pydoc/config/query-classifier.yml index 8e7b855a5..bfe872195 100644 --- a/docs/pydoc/config/query-classifier.yml +++ b/docs/pydoc/config/query-classifier.yml @@ -1,7 +1,7 @@ loaders: - type: loaders.CustomPythonLoader search_path: [../../../haystack/nodes/query_classifier] - modules: ["base", "sklearn", "transformers"] + modules: ["sklearn", "transformers"] ignore_when_discovered: ["__init__"] processors: - type: filter diff --git a/docs/pydoc/config/ranker.yml b/docs/pydoc/config/ranker.yml index 206a6f0d7..e38ab900f 100644 --- a/docs/pydoc/config/ranker.yml +++ b/docs/pydoc/config/ranker.yml @@ -1,7 +1,7 @@ loaders: - type: loaders.CustomPythonLoader search_path: [../../../haystack/nodes/ranker] - modules: ["base", "sentence_transformers", "recentness_ranker", "diversity", "lost_in_the_middle"] + modules: ["sentence_transformers", "recentness_ranker", "diversity", "lost_in_the_middle"] ignore_when_discovered: ["__init__"] processors: - type: filter diff --git a/docs/pydoc/config/reader.yml b/docs/pydoc/config/reader.yml index 013f9cae6..c1959f8c6 100644 --- a/docs/pydoc/config/reader.yml +++ b/docs/pydoc/config/reader.yml @@ -1,7 +1,7 @@ loaders: - type: loaders.CustomPythonLoader search_path: [../../../haystack/nodes/reader] - modules: ["base", "farm", "transformers", "table"] + modules: ["farm", "transformers", "table"] ignore_when_discovered: ["__init__"] processors: - type: filter diff --git a/docs/pydoc/config/retriever.yml b/docs/pydoc/config/retriever.yml index 3003f7892..6b7da4c99 100644 --- a/docs/pydoc/config/retriever.yml +++ b/docs/pydoc/config/retriever.yml @@ -1,7 +1,7 @@ loaders: - type: loaders.CustomPythonLoader search_path: [../../../haystack/nodes/retriever] - modules: ["base", "sparse", "dense", "multimodal/retriever", "web", "link_content"] + modules: ["sparse", "dense", "multimodal/retriever", "web", "link_content"] ignore_when_discovered: ["__init__"] processors: - type: filter diff --git a/docs/pydoc/config/summarizer.yml b/docs/pydoc/config/summarizer.yml index c0045c9c6..329153ef4 100644 --- a/docs/pydoc/config/summarizer.yml +++ b/docs/pydoc/config/summarizer.yml @@ -1,7 +1,7 @@ loaders: - type: loaders.CustomPythonLoader search_path: [../../../haystack/nodes/summarizer] - modules: ["base", "transformers"] + modules: ["transformers"] ignore_when_discovered: ["__init__"] processors: - type: filter diff --git a/docs/pydoc/config/transformers-img-to-text.yml b/docs/pydoc/config/transformers-img-to-text.yml index f58b0a777..96160b1ac 100644 --- a/docs/pydoc/config/transformers-img-to-text.yml +++ b/docs/pydoc/config/transformers-img-to-text.yml @@ -1,7 +1,7 @@ loaders: - type: loaders.CustomPythonLoader search_path: [../../../haystack/nodes/image_to_text] - modules: ["base", "transformers"] + modules: ["transformers"] ignore_when_discovered: ["__init__"] processors: - type: filter diff --git a/docs/pydoc/config/translator.yml b/docs/pydoc/config/translator.yml index 41e8af4d4..8d33ec7db 100644 --- a/docs/pydoc/config/translator.yml +++ b/docs/pydoc/config/translator.yml @@ -1,7 +1,7 @@ loaders: - type: loaders.CustomPythonLoader search_path: [../../../haystack/nodes/translator] - modules: ["base", "transformers"] + modules: ["transformers"] ignore_when_discovered: ["__init__"] processors: - type: filter