lfoppiano commited on
Commit
42fadd1
·
verified ·
1 Parent(s): 7ac538b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +142 -1
README.md CHANGED
@@ -7,4 +7,145 @@ sdk: static
7
  pinned: false
8
  ---
9
 
10
- Edit this `README.md` markdown file to author your organization card.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
7
  pinned: false
8
  ---
9
 
10
+ # GROBID Organization
11
+
12
+ ## About GROBID
13
+
14
+ GROBID (GeneRation Of BIbliographic Data) is a machine learning library for extracting, parsing and re-structuring raw documents such as PDF into structured XML/TEI encoded documents with a particular focus on technical and scientific publications.
15
+
16
+ ## The Organization
17
+
18
+ GROBID is an **open source project** supported by:
19
+ - **[INRIA](https://www.inria.fr/)** (French National Institute for Research in Digital Science and Technology)
20
+ - **MESRE** (French Ministry of Higher Education, Research and Innovation)
21
+
22
+ The project is **maintained by [Luca Foppiano](https://github.com/lfoppiano)**, continuing the work initiated by [Patrice Lopez](https://github.com/kermitt2), GROBID's original creator.
23
+
24
+ ## History
25
+
26
+ GROBID was created in 2008 by Patrice Lopez as a personal project, following a suggestion by Laurent Romary (Inria, France). In 2011, the tool was made available as open source. Since the beginning, development has been continuous, facilitated in particular by the ongoing support of Inria.
27
+
28
+ ## Key Functionalities
29
+
30
+ GROBID offers the following functionalities for extracting and structuring scientific documents:
31
+
32
+ - **Metadata extraction and parsing**: title, abstract, authors, affiliations, keywords
33
+ - **Reference extraction and parsing**: with approximately 0.87 F1-score (Deep Learning)
34
+ - **Citation context recognition** and resolution of full bibliographical references
35
+ - **Full text extraction and structuring**: paragraphs, section titles, reference callouts, figures, tables
36
+ - **PDF coordinates** to create "augmented" interactive PDFs
37
+ - **Parsing of references in isolation**: over 0.90 F1-score at instance level
38
+ - **Name parsing**: author names, affiliations, addresses
39
+ - **Consolidation/resolution** of bibliographical references via biblio-glutton or CrossRef API
40
+ - **Funding information extraction** with optional matching with CrossRef Funder Registry
41
+ - **Copyright and license identification** associated with the document
42
+
43
+ ## Production Deployments
44
+
45
+ GROBID is used in production by numerous major organizations and platforms:
46
+ - OpenAlex
47
+ - ResearchGate
48
+ - Semantic Scholar
49
+ - HAL Research Archive
50
+ - scite.ai
51
+ - Matilda
52
+ - Academia.edu
53
+ - Internet Archive Scholar
54
+ - INIST-CNRS
55
+ - CERN (Invenio)
56
+ - And many more...
57
+
58
+ ## Repositories and Resources
59
+
60
+ ### Main Repository
61
+ - **[grobid](https://github.com/kermitt2/grobid)**: Main GROBID library
62
+
63
+ ### Clients
64
+ - **[grobid-client-python](https://github.com/kermitt2/grobid-client-python)**: Python client for GROBID
65
+ - **[grobid-client-java](https://github.com/kermitt2/grobid-client-java)**: Java client for GROBID
66
+ - **[grobid-client-node](https://github.com/kermitt2/grobid-client-node)**: Node.js client for GROBID
67
+
68
+ ### Specialized Modules
69
+ - **[software-mention](https://github.com/ourresearch/software-mentions)**: Recognition of software mentions
70
+ - **[datastet](https://github.com/kermitt2/datastet)**: Identification of datasets in scientific articles
71
+ - **[grobid-quantities](https://github.com/kermitt2/grobid-quantities)**: Recognition and normalization of physical quantities
72
+ - **[grobid-superconductors](https://github.com/lfoppiano/grobid-superconductors)**: Recognition of superconductor materials
73
+ - **[entity-fishing](https://github.com/kermitt2/entity-fishing)**: Wikidata entity extraction
74
+ - **[grobid-ner](https://github.com/kermitt2/grobid-ner)**: Named entity recognition
75
+ - **[grobid-astro](https://github.com/kermitt2/grobid-astro)**: Recognition of astronomical entities
76
+ - **[grobid-dictionaries](https://github.com/MedKhem/grobid-dictionaries)**: Dictionary structuring
77
+
78
+ ### Tools and Utilities
79
+ - **[delft](https://github.com/kermitt2/delft)**: Deep Learning framework for sequence labeling
80
+ - **[biblio-glutton](https://github.com/kermitt2/biblio-glutton)**: Bibliographic consolidation service
81
+ - **[pdfalto](https://github.com/kermitt2/pdfalto)**: Extraction of visual/layout information from PDFs
82
+ - **[article-dataset-builder](https://github.com/kermitt2/article-dataset-builder)**: Creation of structured scientific article corpora
83
+
84
+ ## Documentation
85
+
86
+ 📚 **Full documentation**: [https://grobid.readthedocs.io](https://grobid.readthedocs.io)
87
+
88
+ The documentation covers:
89
+ - Quick start guide
90
+ - Installation and configuration
91
+ - API and web services
92
+ - Model training
93
+ - Benchmarking and evaluation
94
+ - Docker deployment
95
+
96
+ ## Demo
97
+
98
+ ### Demo Servers
99
+
100
+ Two public demo servers are available thanks to HuggingFace:
101
+
102
+ - [https://grobidOrg-grobid.hf.space/](https://grobidOrg-grobid.hf.space/)
103
+ - [https://grobidOrg-grobid2.hf.space/](https://grobidOrg-grobid2.hf.space/)
104
+
105
+ ⚠️ **Warning**: These demo servers are using only CRF models (faster) and have quota limitations. For serious use, please deploy your own GROBID server.
106
+
107
+ ## Performance
108
+
109
+ GROBID is designed for speed and high scalability:
110
+
111
+ - **Large-scale processing**: Approximately 10.6 PDF per second (915,000 PDF per day)
112
+ - **Production ready**: Used by numerous platforms in production
113
+ - **Parallelization**: Native support for parallel processing
114
+
115
+ ## License
116
+
117
+ GROBID is distributed under [Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0) license.
118
+
119
+ The documentation is distributed under [CC-0](https://creativecommons.org/publicdomain/zero/1.0/) license and annotated data under [CC-BY](https://creativecommons.org/licenses/by/4.0/) license.
120
+
121
+ ## Contact
122
+
123
+ - **Main Maintainer**: Luca Foppiano ([GitHub](https://github.com/lfoppiano))
124
+ - **Original Creator**: Patrice Lopez ([patrice.lopez@science-miner.com](mailto:patrice.lopez@science-miner.com))
125
+
126
+ ## How to Cite GROBID
127
+
128
+ If you use GROBID in your research, please cite:
129
+
130
+ ```bibtex
131
+ @misc{GROBID,
132
+ title = {GROBID},
133
+ key = {GROBID},
134
+ howpublished = {\url{https://github.com/kermitt2/grobid}},
135
+ publisher = {GitHub},
136
+ date = {2008/2026},
137
+ archivePrefix = {swh},
138
+ eprint = {1:dir:dab86b296e3c3216e2241968f0d63b68e8209d3c}
139
+ }
140
+ ```
141
+
142
+ ## Contributing
143
+
144
+ Contributions are welcome! If you contribute to GROBID, you agree to share your contribution under the licenses mentioned above.
145
+
146
+ For more information on contributing to the project, consult the documentation on GitHub.
147
+
148
+ ---
149
+
150
+ *GROBID is an open source project supported by INRIA and MESRE, maintained by Luca Foppiano in continuation of the work of Patrice Lopez.*
151
+