Skip to content

Commit

Permalink
correct icons
Browse files Browse the repository at this point in the history
  • Loading branch information
lfoppiano committed Feb 29, 2024
1 parent 238aeea commit 2ca336a
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion doc/evaluation-scores.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ ref"}.
The scores of this evaluation were obtained using n-fold
cross-validation. The metrics are the micro average of n=10 folds.

> :note: The paper \"Automatic Identification and Normalisation of Physical Measurements in Scientific Literature,\"
> :information_source: The paper \"Automatic Identification and Normalisation of Physical Measurements in Scientific Literature,\"
> published in September 2019, reported macro averaged evaluation scores.

Expand Down
2 changes: 1 addition & 1 deletion doc/gettingStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ To test the API, is possible to run a simple text using `curl`:
curl -X POST -F "text=I've lost two minutes." localhost:8060/service/processQuantityText
```

> :note: The model is designed and trained to work at *paragraph level*. The expected text input to the parser is a paragraph or a text segment of similar size, not a complete document. In case you have a long textual document, it is better either to exploit existing structures (e.g. XML/HTML `<p>` elements) to initially segment it into paragraphs or sentences, or to apply an automatic paragraph/sentence segmentation. Then send them separately to grobid-quantities to be processed.
> :information_source: The model is designed and trained to work at *paragraph level*. The expected text input to the parser is a paragraph or a text segment of similar size, not a complete document. In case you have a long textual document, it is better either to exploit existing structures (e.g. XML/HTML `<p>` elements) to initially segment it into paragraphs or sentences, or to apply an automatic paragraph/sentence segmentation. Then send them separately to grobid-quantities to be processed.

#### Using the python client
Expand Down
10 changes: 5 additions & 5 deletions doc/guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ repository `resources/dataset/${model}/corpus/` for retraining, or under `resouc
annotated data should be used for evaluation only. To see the different evaluation options, see GROBID documentation
on [training and evaluating](training.md).

> :note: the exact directory where the data is picked up could be also a `final` under `corpus`. Please check the
> :information_source: the exact directory where the data is picked up could be also a `final` under `corpus`. Please check the
> description under each model definition, below.
In this document, after the general rules, we describe the annotation guidelines for the following models:
Expand All @@ -39,18 +39,18 @@ Currently, it supports three types of measurements:
- continuous values in intervals (or range of values),
- lists of discrete values.

> :note: At the present time we do not distinguish between conjunctive and disjunctive lists.
> :information_source: At the present time we do not distinguish between conjunctive and disjunctive lists.
### Unit type vocabulary

The list of unit types (temperature, pressure, length, etc.) is controlled and based on SI definition. This controlled vocabulary contains currently around 50 types. The unit types are provided in the
file `src/main/java/org/grobid/core/utilities/UnitUtilities.java` and they are used to get the right transformation.

> :note: at the moment we do not support disambiguation of overlapping units.
> :information_source: at the moment we do not support disambiguation of overlapping units.
The given names of the unit types has to be used when annotating measurement.

> :note: In the future, the list of units should however not be controlled and GROBID should support units never seen before. For now, it is admitted to annotate with `UNKNOWN` in case of doubt about the type.
> :information_source: In the future, the list of units should however not be controlled and GROBID should support units never seen before. For now, it is admitted to annotate with `UNKNOWN` in case of doubt about the type.
Examples:

Expand Down Expand Up @@ -682,7 +682,7 @@ Object\>.\</p\>
The quantified object is identified by its ID and linked to the measure
via the attribute [ptr=\"#ID\"]{.title-ref}.

> :note: This implementation allows the linking of objects directly attached on the left or right of the measurement, for the time being far entities
> :information_source: This implementation allows the linking of objects directly attached on the left or right of the measurement, for the time being far entities
are not supported.

### How to annotate?
Expand Down
2 changes: 1 addition & 1 deletion doc/training.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ java -Djava.library.path=../grobid-home/lib/{arch}/:{MY_VIRTUAL_ENV}/lib:{MY_VIR

Grobid-quantities can be evaluated using a random `80/20` ratio, an `holdout` set, or as `n-fold cross-validation`.

> :note: Since 12/2022, the holdout evaluation is the default means of evaluation for all the models.
> :information_source: Since 12/2022, the holdout evaluation is the default means of evaluation for all the models.
The holdout datasets information and statistics (such as out of domain entities, overlapping rate, etc.) can be found in the Readme.md under each model directory:

Expand Down

0 comments on commit 2ca336a

Please sign in to comment.