Skip to content

Commit

Permalink
update doc with new version number
Browse files Browse the repository at this point in the history
  • Loading branch information
@kermitt2
kermitt2 committed Oct 17, 2019
1 parent 00c0dfc commit 41ab936
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 28 deletions.
30 changes: 15 additions & 15 deletions doc/Grobid-batch.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The following command display some help for the batch commands:

Be sure to replace `<current version>` with the current version of GROBID that you have installed and built. For example:
```bash
> java -jar grobid-core/build/libs/grobid-core-0.5.5-onejar.jar -h
> java -jar grobid-core/build/libs/grobid-core-0.5.6-onejar.jar -h
```

The available batch commands are listed bellow. For those commands, at least `-Xmx1G` is used to set the JVM memory to avoid *OutOfMemoryException* given the current size of the Grobid models and the crazyness of some PDF. For complete fulltext processing, which involve all the GROBID models, `-Xmx4G` is recommended (although allocating less memory is usually fine).
Expand All @@ -40,7 +40,7 @@ The needed parameters for that command are:

Example:
```bash
> java -Xmx1G -jar grobid-core/build/libs/grobid-core-0.5.5-onejar.jar -gH grobid-home -dIn /path/to/input/directory -dOut /path/to/output/directory -r -exe processHeader
> java -Xmx1G -jar grobid-core/build/libs/grobid-core-0.5.6-onejar.jar -gH grobid-home -dIn /path/to/input/directory -dOut /path/to/output/directory -r -exe processHeader
```

WARNING: the expected extension of the PDF files to be processed is .pdf
Expand All @@ -62,7 +62,7 @@ WARNING: the expected extension of the PDF files to be processed is .pdf

Example:
```bash
> java -Xmx4G -jar grobid-core/build/libs/grobid-core-0.5.5-onejar.jar -gH grobid-home -dIn /path/to/input/directory -dOut /path/to/output/directory -exe processFullText
> java -Xmx4G -jar grobid-core/build/libs/grobid-core-0.5.6-onejar.jar -gH grobid-home -dIn /path/to/input/directory -dOut /path/to/output/directory -exe processFullText
```

WARNING: the expected extension of the PDF files to be processed is .pdf
Expand All @@ -76,7 +76,7 @@ WARNING: the expected extension of the PDF files to be processed is .pdf

Example:
```bash
> java -Xmx1G -jar grobid-core/build/libs/grobid-core-0.5.5-onejar.jar -gH grobid-home -exe processDate -s "some date to extract and format"
> java -Xmx1G -jar grobid-core/build/libs/grobid-core-0.5.6-onejar.jar -gH grobid-home -exe processDate -s "some date to extract and format"
```

### processAuthorsHeader
Expand All @@ -88,7 +88,7 @@ Example:

Example:
```bash
> java -Xmx1G -jar grobid-core/build/libs/grobid-core-0.5.5-onejar.jar -gH grobid-home -exe processAuthorsHeader -s "some authors"
> java -Xmx1G -jar grobid-core/build/libs/grobid-core-0.5.6-onejar.jar -gH grobid-home -exe processAuthorsHeader -s "some authors"
```

### processAuthorsCitation
Expand All @@ -100,7 +100,7 @@ Example:

Example:
```bash
> java -Xmx1G -jar grobid-core/build/libs/grobid-core-0.5.5-onejar.jar -gH grobid-home -exe processAuthorsCitation -s "some authors"
> java -Xmx1G -jar grobid-core/build/libs/grobid-core-0.5.6-onejar.jar -gH grobid-home -exe processAuthorsCitation -s "some authors"
```

### processAffiliation
Expand All @@ -112,7 +112,7 @@ Example:

Example:
```bash
> java -Xmx1G -jar grobid-core/build/libs/grobid-core-0.5.5-onejar.jar -gH grobid-home -exe processAffiliation -s "some affiliation"
> java -Xmx1G -jar grobid-core/build/libs/grobid-core-0.5.6-onejar.jar -gH grobid-home -exe processAffiliation -s "some affiliation"
```

### processRawReference
Expand All @@ -124,7 +124,7 @@ Example:

Example:
```bash
> java -Xmx1G -jar grobid-core/build/libs/grobid-core-0.5.5-onejar.jar -gH grobid-home -exe processRawReference -s "a reference string"
> java -Xmx1G -jar grobid-core/build/libs/grobid-core-0.5.6-onejar.jar -gH grobid-home -exe processRawReference -s "a reference string"
```

### processReferences
Expand All @@ -140,7 +140,7 @@ Example:

Example:
```bash
> java -Xmx2G -jar grobid-core/build/libs/grobid-core-0.5.5-onejar.jar -gH grobid-home -dIn /path/to/input/directory -dOut /path/to/output/directory -exe processReferences
> java -Xmx2G -jar grobid-core/build/libs/grobid-core-0.5.6-onejar.jar -gH grobid-home -dIn /path/to/input/directory -dOut /path/to/output/directory -exe processReferences
```

WARNING: the expected extension of the PDF files to be processed is .pdf
Expand All @@ -156,7 +156,7 @@ WARNING: the expected extension of the PDF files to be processed is .pdf

Example:
```bash
> java -Xmx1G -jar grobid-core/build/libs/grobid-core-0.5.5-onejar.jar -gH grobid-home -dIn /path/to/input/directory -dOut /path/to/output/directory -exe processCitationPatentST36
> java -Xmx1G -jar grobid-core/build/libs/grobid-core-0.5.6-onejar.jar -gH grobid-home -dIn /path/to/input/directory -dOut /path/to/output/directory -exe processCitationPatentST36
```

WARNING: extension of the ST.36 files to be processed must be .xml
Expand All @@ -172,7 +172,7 @@ WARNING: extension of the ST.36 files to be processed must be .xml

Example:
```
> java -Xmx1G -jar grobid-core/build/libs/grobid-core-0.5.5-onejar.jar -gH grobid-home -dIn /path/to/input/directory -dOut /path/to/output/directory -exe processCitationPatentTXT
> java -Xmx1G -jar grobid-core/build/libs/grobid-core-0.5.6-onejar.jar -gH grobid-home -dIn /path/to/input/directory -dOut /path/to/output/directory -exe processCitationPatentTXT
```

WARNING: extension of the text files to be processed must be .txt, and expected encoding is UTF-8
Expand All @@ -188,7 +188,7 @@ WARNING: extension of the text files to be processed must be .txt, and expected

Example:
```
> java -Xmx1G -jar grobid-core/build/libs/grobid-core-0.5.5-onejar.jar -gH grobid-home -dIn /path/to/input/directory -dOut /path/to/output/directory -exe processCitationPatentPDF
> java -Xmx1G -jar grobid-core/build/libs/grobid-core-0.5.6-onejar.jar -gH grobid-home -dIn /path/to/input/directory -dOut /path/to/output/directory -exe processCitationPatentPDF
```

WARNING: extension of the text files to be processed must be .pdf
Expand All @@ -204,7 +204,7 @@ WARNING: extension of the text files to be processed must be .pdf

Example:
```bash
> java -Xmx4G -jar grobid-core/build/libs/grobid-core-0.5.5-onejar.jar -gH grobid-home -dIn /path/to/input/directory -dOut /path/to/output/directory -exe createTraining
> java -Xmx4G -jar grobid-core/build/libs/grobid-core-0.5.6-onejar.jar -gH grobid-home -dIn /path/to/input/directory -dOut /path/to/output/directory -exe createTraining
```

WARNING: the expected extension of the PDF files to be processed is .pdf
Expand All @@ -220,7 +220,7 @@ WARNING: the expected extension of the PDF files to be processed is .pdf

Example:
```bash
> java -Xmx4G -jar grobid-core/build/libs/grobid-core-0.5.5-onejar.jar -gH grobid-home -dIn /path/to/input/directory -dOut /path/to/output/directory -exe createTrainingBlank
> java -Xmx4G -jar grobid-core/build/libs/grobid-core-0.5.6-onejar.jar -gH grobid-home -dIn /path/to/input/directory -dOut /path/to/output/directory -exe createTrainingBlank
```

WARNING: the expected extension of the PDF files to be processed is .pdf
Expand All @@ -238,7 +238,7 @@ The needed parameters for that command are:

Example:
```
> java -Xmx2G -jar grobid-core/build/libs/grobid-core-0.5.5-onejar.jar -gH grobid-home -dIn /path/to/input/directory -dOut /path/to/output/directory -r -exe processPDFAnnotation
> java -Xmx2G -jar grobid-core/build/libs/grobid-core-0.5.6-onejar.jar -gH grobid-home -dIn /path/to/input/directory -dOut /path/to/output/directory -r -exe processPDFAnnotation
```

WARNING: extension of the text files to be processed must be .pdf
12 changes: 6 additions & 6 deletions doc/Grobid-java-library.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,20 +33,20 @@ Here an example of grobid-core dependency:
<dependency>
<groupId>org.grobid</groupId>
<artifactId>grobid-core</artifactId>
<version>0.5.5</version>
<version>0.5.6</version>
</dependency>
```

If you want to work on a SNAPSHOT development version, you need to include in your pom file the path to the Grobid jar file,
for instance as follow (if necessary replace `0.5.5` by the valid `<current version>`):
for instance as follow (if necessary replace `0.5.6` by the valid `<current version>`):

```xml
<dependency>
<groupId>org.grobid</groupId>
<artifactId>grobid-core</artifactId>
<version>0.5.5</version>
<version>0.5.6</version>
<scope>system</scope>
<systemPath>${project.basedir}/lib/grobid-core-0.5.5.jar</systemPath>
<systemPath>${project.basedir}/lib/grobid-core-0.5.6.jar</systemPath>
</dependency>
```

Expand All @@ -64,8 +64,8 @@ Add the following snippet in your gradle.build file:

and add the Grobid dependency as well:
```
compile 'org.grobid:grobid-core:0.5.5'
compile 'org.grobid:grobid-trainer:0.5.5'
compile 'org.grobid:grobid-core:0.5.6'
compile 'org.grobid:grobid-trainer:0.5.6'
```


Expand Down
6 changes: 3 additions & 3 deletions doc/Grobid-service.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ You could also build and install the service as a standalone service (let's supp
> cd ..
> mkdir grobid-installation
> cd grobid-installation
> unzip ../grobid/grobid-service/build/distributions/grobid-service-0.5.5.zip
mv grobid-service-0.5.5 grobid-service
> unzip ../grobid/grobid-home/build/distributions/grobid-home-0.5.5.zip
> unzip ../grobid/grobid-service/build/distributions/grobid-service-0.5.6.zip
mv grobid-service-0.5.6 grobid-service
> unzip ../grobid/grobid-home/build/distributions/grobid-home-0.5.6.zip
> ./grobid-service/bin/grobid-service server grobid-service/config/config.yaml
```

Expand Down
8 changes: 4 additions & 4 deletions doc/Install-Grobid.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@ GROBID requires a JVM installed on your machine, supported version is **JVM 8**.

###Latest stable release

The [latest stable release](https://github.com/kermitt2/grobid#latest-version) of GROBID is version ```0.5.5``` which can be downloaded as follow:
The [latest stable release](https://github.com/kermitt2/grobid#latest-version) of GROBID is version ```0.5.6``` which can be downloaded as follow:
```bash
> wget https://github.com/kermitt2/grobid/archive/0.5.5.zip
> unzip 0.5.5.zip
> wget https://github.com/kermitt2/grobid/archive/0.5.6.zip
> unzip 0.5.6.zip
```

or using the [docker](Grobid-docker.md) container.

###Current development version

The current development version is ```0.5.6-SNAPSHOT```, which can be downloaded from GitHub and built as follow:
The current development version is ```0.6.0-SNAPSHOT```, which can be downloaded from GitHub and built as follow:

Clone source code from github:
```bash
Expand Down

0 comments on commit 41ab936

Please sign in to comment.