Skip to content

Commit a270f1b

Browse files
551 doc updates minor fix (#1648)
* 551 documentation updated. * added StructuredJsonConverter doc * added some new parameters doc * 551 documentation fix --------- Co-authored-by: Mehmet Butgul <mehmetbutgulmail@gmail.com>
1 parent 5154129 commit a270f1b

File tree

4 files changed

+16
-4
lines changed

4 files changed

+16
-4
lines changed

docs/en/licensed_annotator_entries/ContextualEntityFilterer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ val result = nlpPipeline.fit(df).transform(df)
186186
{%- endcapture -%}
187187

188188
{%- capture model_python_api_link -%}
189-
[ContextualEntityFilterer](https://nlp.johnsnowlabs.com/licensed/api/python/reference/autosummary/sparknlp_jsl/annotator/context/ContextualEntityFilterer/index.html)
189+
[ContextualEntityFilterer](https://nlp.johnsnowlabs.com/licensed/api/python/reference/autosummary/sparknlp_jsl/annotator/context/contextual_entity_filterer/index.html)
190190
{%- endcapture -%}
191191

192192
{%- capture model_notebook_link -%}

docs/en/licensed_annotator_entries/ContextualEntityRuler.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,10 @@ val result = nlpPipeline.fit(df).transform(df)
239239
{%- endcapture -%}
240240

241241
{%- capture model_python_api_link -%}
242-
[ContextualEntityRuler](https://nlp.johnsnowlabs.com/licensed/api/python/reference/autosummary/sparknlp_jsl/annotator/context/ContextualEntityRuler/index.html)
242+
243+
[ContextualEntityRuler](https://nlp.johnsnowlabs.com/licensed/api/python/reference/autosummary/sparknlp_jsl/annotator/context/contextual_entity_ruler/index.html)
244+
245+
243246
{%- endcapture -%}
244247

245248
{%- capture model_notebook_link -%}

docs/en/licensed_annotator_entries/PretrainedZeroShotNER.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,9 @@ val result = pipelineModel.transform(data)
187187
{%- endcapture -%}
188188

189189
{%- capture model_python_api_link -%}
190-
[PretrainedZeroShotNER](https://nlp.johnsnowlabs.com/licensed/api/python/reference/autosummary/sparknlp_jsl/annotator/ner/PretrainedZeroShotNER/index.html)
190+
191+
[PretrainedZeroShotNER](https://nlp.johnsnowlabs.com/licensed/api/python/reference/autosummary/sparknlp_jsl/annotator/ner/pretrained_zero_shot_ner/index.html)
192+
191193
{%- endcapture -%}
192194

193195
{%- capture model_notebook_link -%}

docs/en/licensed_annotator_entries/StructuredJsonConverter.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,10 @@ Parameters:
1818
- `cleanAnnotations`: Whether to remove annotation columns, by default False.
1919
- `returnRelationEntities`: Whether to return the entities in the relations or not, by default False.
2020
- `outputAsStr`: Whether to output the result as a string or as a structured json, by default True.
21-
```plaintext
21+
22+
23+
```
24+
2225
When set to `True`, the output column will be a string:
2326
2427
|-- column_name: string (nullable = true)
@@ -55,7 +58,11 @@ When set to False, the output column will be a struct with the following schema:
5558
| |-- element: map (containsNull = true)
5659
| |-- key: string
5760
| |-- value: string (valueContainsNull = true)
61+
62+
5863
```
64+
65+
5966
- `converterSchema` and `converterSchemaAsStr`: The schema for converting the output of the pipeline into a structured JSON format. Fields in the schema:
6067
- `document_identifier`: The identifier of the document. This column must be of type `StringType`.
6168
- `document_text`: The text of the document, typically created by the `DocumentAssembler` annotator.

0 commit comments

Comments
 (0)