Skip to content
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

feat: Updates docs and types for language param in PreProcessor #3186

Merged
merged 7 commits into from
Sep 12, 2022
Merged

feat: Updates docs and types for language param in PreProcessor #3186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ca2f6a4
Small update to language param in PreProcessor
sjrl Sep 8, 2022
9edd138
Update to API docs
sjrl Sep 8, 2022
3627b18
Added missing option
sjrl Sep 8, 2022
e4e6ecc
Removing literal b/c we want to be able to request custom punkt token…
sjrl Sep 8, 2022
d40262f
Remove unneeded import
sjrl Sep 8, 2022
8d6a188
Merge branch 'main' of github.com:deepset-ai/haystack into preproc_up…
sjrl Sep 9, 2022
d6c8a5b
Removed unused variable
sjrl Sep 9, 2022
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
3 changes: 2 additions & 1 deletion docs/_src/api/api/preprocessor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,8 @@ Set the value to 0 to ensure there is no overlap among the documents after split
- `split_respect_sentence_boundary`: Whether to split in partial sentences if split_by -> `word`. If set
to True, the individual split will always have complete sentences &
the number of words will be <= split_length.
- `language`: The language used by "nltk.tokenize.sent_tokenize" in iso639 format. Available options: "en", "es", "de", "fr" & many more.
- `language`: The language used by "nltk.tokenize.sent_tokenize" in iso639 format.
Available options: "ru","sl","es","sv","tr","cs","da","nl","en","et","fi","fr","de","el","it","no","pl","pt","ml"
- `tokenizer_model_folder`: Path to the folder containing the NTLK PunktSentenceTokenizer models, if loading a model from a local path. Leave empty otherwise.
- `id_hash_keys`: Generate the document id from a custom list of strings that refer to the document's
attributes. If you want to ensure you don't have duplicate documents in your DocumentStore but texts are
Expand Down
7 changes: 3 additions & 4 deletions haystack/nodes/preprocessor/preprocessor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
"no": "norwegian",
"pl": "polish",
"pt": "portuguese",
"ml": "malayalam",
}


Expand Down Expand Up @@ -79,7 +80,8 @@ def __init__(
:param split_respect_sentence_boundary: Whether to split in partial sentences if split_by -> `word`. If set
to True, the individual split will always have complete sentences &
the number of words will be <= split_length.
:param language: The language used by "nltk.tokenize.sent_tokenize" in iso639 format. Available options: "en", "es", "de", "fr" & many more.
:param language: The language used by "nltk.tokenize.sent_tokenize" in iso639 format.
Available options: "ru","sl","es","sv","tr","cs","da","nl","en","et","fi","fr","de","el","it","no","pl","pt","ml"
:param tokenizer_model_folder: Path to the folder containing the NTLK PunktSentenceTokenizer models, if loading a model from a local path. Leave empty otherwise.
:param id_hash_keys: Generate the document id from a custom list of strings that refer to the document's
attributes. If you want to ensure you don't have duplicate documents in your DocumentStore but texts are
Expand Down Expand Up @@ -152,13 +154,10 @@ def process(
if id_hash_keys is None:
id_hash_keys = self.id_hash_keys

ret = []

if isinstance(documents, (Document, dict)):
ret = self._process_single(document=documents, id_hash_keys=id_hash_keys, **kwargs) # type: ignore
elif isinstance(documents, list):
ret = self._process_batch(documents=list(documents), id_hash_keys=id_hash_keys, **kwargs)

else:
raise Exception("documents provided to PreProcessor.prepreprocess() is not of type list nor Document")

Expand Down