Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
lfoppiano committed Jun 9, 2024
1 parent 0a95872 commit b6a2a20
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
5 changes: 3 additions & 2 deletions doc/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ CORS for the GROBID web API service can be configurated by the following yaml pa

GROBID uses external implementation for recognizing the language used in a publication and for performing sentence disambiguation.

There is currently only one possible language recognition implementation possible (Cybozu Language Detector) and two possible sentence segmenters (OpenNLP, default and the Pragmatic Segmenter).
There is currently only one possible language recognition implementation possible (Cybozu Language Detector) and two possible sentence segmenters (OpenNLP (default) and the Pragmatic Segmenter).

```yml
# the actual implementation for language recognition to be used
Expand All @@ -95,6 +95,7 @@ There is currently only one possible language recognition implementation possibl
#sentenceDetectorFactory: "org.grobid.core.lang.impl.PragmaticSentenceDetectorFactory"
sentenceDetectorFactory: "org.grobid.core.lang.impl.OpenNLPSentenceDetectorFactory"
```
**NOTE**: While OpenNLP is 60 time faster than the Pragmatic Segmenter, it performs "slightly" worst. The pragmatic segmenter runs with the JRuby Interpreter.

### Service configuration

Expand All @@ -121,7 +122,7 @@ When executing the service, models can be loaded in a lazy manner (if you plan t
modelPreload: true
```

Finally the following part specifies the port to be used by the GROBID web service:
Finally, the following part specifies the port to be used by the GROBID web service:

```yml
server:
Expand Down
2 changes: 1 addition & 1 deletion doc/Notes-grobid-developers.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ In order to make a new release:

+ create a github release: the easiest is to use the GitHub web interface

+ do something to publish the Java artefacts... currrently just uploading them on AWS S3
+ do something to publish the Java artefacts... currently just uploading them on AWS S3

+ you're not done, you need to update the documentation, `Readme.md`, `CHANGELOG.md` and end-to-end benchmarking (PMC and bioRxiv sets).

Expand Down

0 comments on commit b6a2a20

Please sign in to comment.