Skip to content

Commit 53adaf1

Browse files
ksudermanclaude
andcommitted
Fix CoreNLP docs: add param help, fold READMEs into tool/DM help, remove stale test-data README, correct language and model-size claims
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent ccb8541 commit 53adaf1

5 files changed

Lines changed: 46 additions & 173 deletions

File tree

data_managers/data_manager_corenlp_models/README.md

Lines changed: 0 additions & 63 deletions
This file was deleted.

data_managers/data_manager_corenlp_models/data_manager/data_manager_corenlp_models.xml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@
1818
#end if
1919
]]></command>
2020
<inputs>
21-
<param name="languages" type="select" label="Language Models" multiple="true" display="checkboxes">
21+
<param name="languages" type="select" label="Language Models" multiple="true" display="checkboxes"
22+
help="Select one or more languages to download. Each model JAR is fetched from Maven Central and registered in the corenlp_models data table. Downloads are large (tens to hundreds of MB each) and may take several minutes.">
2223
<option value="ar">Arabic</option>
2324
<option value="zh">Chinese</option>
2425
<option value="en" selected="true">English</option>
@@ -77,8 +78,8 @@ Usage
7778
3. Run the data manager
7879
4. The model JARs will be downloaded from Maven Central and registered in the data table
7980
80-
The language models are large files (typically 100-500 MB each), so downloading
81-
multiple models may take several minutes depending on your connection speed.
81+
The language models are large files (from ~80 MB up to several hundred MB each), so
82+
downloading multiple models may take several minutes depending on your connection speed.
8283
8384
Common Models
8485
-------------

tools/corenlp/README.md

Lines changed: 0 additions & 60 deletions
This file was deleted.

tools/corenlp/stanford_corenlp.xml

Lines changed: 42 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,10 @@ parse.model = edu/stanford/nlp/models/lexparser/italianFactored.ser.gz
8181
]]></configfile>
8282
</configfiles>
8383
<inputs>
84-
<param name="input" type="data" format="txt" label="Text"/>
85-
<param name="language_model" type="select" label="Language Model">
84+
<param name="input" type="data" format="txt" label="Text"
85+
help="Plain text file to annotate. Its language must match the selected language model."/>
86+
<param name="language_model" type="select" label="Language Model"
87+
help="Which installed CoreNLP language model to use. Models are installed by an administrator via the Stanford CoreNLP Language Models data manager (Admin &gt; Local Data). Full annotation is available for English, Chinese, French, German, Italian, and Spanish; Arabic and Hungarian support segmentation only.">
8688
<options from_data_table="corenlp_models">
8789
<column name="value" index="0"/>
8890
<column name="name" index="1"/>
@@ -94,15 +96,17 @@ parse.model = edu/stanford/nlp/models/lexparser/italianFactored.ser.gz
9496
<filter type="sort_by" column="1"/>
9597
</options>
9698
</param>
97-
<param name="annotators" type="select" label="Annotation types">
99+
<param name="annotators" type="select" label="Annotation types"
100+
help="Which CoreNLP annotators to run. Selections are cumulative: each option also runs the annotators it depends on. NER and parsing require an English, Chinese, French, German, Italian, or Spanish model; coreference requires English or Chinese (plus the common models); sentiment requires English.">
98101
<option value="tokenize" selected="true">Segmentation (sentences and tokens) - All languages</option>
99102
<option value="pos">Part of speech and lemmas - All languages</option>
100103
<option value="ner">Named entity recognizer - English, Chinese, French, German, Italian, Spanish</option>
101104
<option value="parse">Dependency/Constituency parser - English, Chinese, French, German, Italian, Spanish</option>
102105
<option value="coref">Coreference - English and Chinese only</option>
103106
<option value="sentiment">Sentiment analysis - English only</option>
104107
</param>
105-
<param name="format" type="select" label="Output format">
108+
<param name="format" type="select" label="Output format"
109+
help="JSON gives the most complete annotation. CoNLL and CoNLL-U are tabular; Text is human-readable; XML is the CoreNLP XML format. Not every annotation is representable in every format (see the help below).">
106110
<option value="json" selected="true">JSON</option>
107111
<option value="conll">CoNLL</option>
108112
<option value="conllu">CoNLL-U</option>
@@ -179,7 +183,7 @@ Part of speech and lemmas
179183
Named entity recognition (NER)
180184
Includes the sentence, token with POS and lemmas, as well as named entities such as PERSON, ORGANIZATION, PLACE, etc.
181185
182-
Dependency parse
186+
Dependency and constituency parse
183187
Includes all of the annotators for NER as well as a dependency parse to
184188
find the dependencies between the words and phrases of a sentence in order
185189
to determine its grammatical structure. Some of the tree structures can
@@ -197,6 +201,39 @@ Sentiment analysis
197201
198202
See: https://stanfordnlp.github.io/CoreNLP/sentiment.html
199203
204+
Supported Languages
205+
===================
206+
207+
Full annotation pipelines (part of speech, NER, parsing, etc.) are available for
208+
English, Chinese, French, German, Italian, and Spanish. Arabic and Hungarian models
209+
can be installed but only support segmentation (tokenization and sentence splitting).
210+
211+
Annotator availability by language:
212+
213+
- Segmentation, part of speech, and lemmas: all installed languages
214+
- Named entity recognition and dependency/constituency parsing: English, Chinese,
215+
French, German, Italian, Spanish
216+
- Coreference: English and Chinese only (requires the common models)
217+
- Sentiment analysis: English only
218+
219+
Output Formats
220+
==============
221+
222+
- **JSON** — full annotations with hierarchical structure (recommended)
223+
- **CoNLL** — tab-separated format for NER and basic annotations
224+
- **CoNLL-U** — Universal Dependencies format
225+
- **Text** — human-readable plain text
226+
- **XML** — CoreNLP structured XML
227+
228+
Installing Language Models
229+
==========================
230+
231+
Language models are installed by a Galaxy administrator using the **Stanford CoreNLP
232+
Language Models** data manager (Admin > Local Data): choose the language(s) to install,
233+
and also install the common models if you need coreference resolution. The tool runs in
234+
the ``ksuderman/corenlp:@TOOL_VERSION@`` Docker container, which bundles the base CoreNLP
235+
library; only the language-specific model JARs are installed separately.
236+
200237
**NOTE**
201238
202239
Please note that not all annotation types can be represented in all of the output

tools/corenlp/test-data/README.md

Lines changed: 0 additions & 42 deletions
This file was deleted.

0 commit comments

Comments
 (0)