Skip to content

Commit 2d03a26

Browse files
Minor lg changes (#2533)
* Minor lg change * Update Documentation & Code Style * Fix missing articles * Update Documentation & Code Style Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 1ae5a14 commit 2d03a26

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

docs/_src/api/api/document_classifier.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -125,18 +125,18 @@ or an entailment.
125125
def predict(documents: List[Document], batch_size: Optional[int] = None) -> List[Document]
126126
```
127127

128-
Returns documents containing classification result in meta field.
128+
Returns documents containing classification result in a meta field.
129129

130130
Documents are updated in place.
131131

132132
**Arguments**:
133133

134-
- `documents`: List of Document to classify
135-
- `batch_size`: Number of Documents to classify at a time.
134+
- `documents`: A list of Documents to classify.
135+
- `batch_size`: The number of Documents to classify at a time.
136136

137137
**Returns**:
138138

139-
List of Document enriched with meta information
139+
A list of Documents enriched with meta information.
140140

141141
<a id="transformers.TransformersDocumentClassifier.predict_batch"></a>
142142

haystack/nodes/document_classifier/transformers.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -136,12 +136,12 @@ def __init__(
136136

137137
def predict(self, documents: List[Document], batch_size: Optional[int] = None) -> List[Document]:
138138
"""
139-
Returns documents containing classification result in meta field.
139+
Returns documents containing classification result in a meta field.
140140
Documents are updated in place.
141141
142-
:param documents: List of Document to classify
143-
:param batch_size: Number of Documents to classify at a time.
144-
:return: List of Document enriched with meta information
142+
:param documents: A list of Documents to classify.
143+
:param batch_size: The number of Documents to classify at a time.
144+
:return: A list of Documents enriched with meta information.
145145
"""
146146
if batch_size is None:
147147
batch_size = self.batch_size

0 commit comments

Comments
 (0)