# grobidorg/grobid architecture

> Architecture diagram of the GitHub repository grobidorg/grobid, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/grobidorg/grobid
- Repository: https://github.com/grobidorg/grobid

## Overview

GROBID is a Java document-understanding system that extracts structured bibliographic and full-text information from PDFs and emits TEI/XML. The principal workflow is a client submitting a document to the REST service, which delegates processing to the core engine and its task parsers; outputs may include PDF coordinates and citation resolution. The README also documents isolated reference parsing, patent extraction, funding and license recognition, and training/evaluation capabilities. Some subsystem paths and links are supported only by documentation or the source index, so those links are marked unverified rather than treated as inspected call paths.

Main entry points: [`grobid-core/src/main/java/org/grobid/core/engines/EngineParsers.java`](https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/engines/EngineParsers.java) (Parser registry), [`grobid-core/src/main/java/org/grobid/core/engines/Engine.java`](https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/engines/Engine.java) (Core engine), [`grobid-core/src/main/java/org/grobid/core/utilities/Consolidation.java`](https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/utilities/Consolidation.java) (Metadata resolution), [`grobid-service/src/main/java/org/grobid/service/GrobidRestService.java`](https://github.com/grobidorg/grobid/blob/master/grobid-service/src/main/java/org/grobid/service/GrobidRestService.java) (REST endpoints)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["Service API"]
  node_rest["REST endpoints"]
  node_fileproc["File processing"]
end

subgraph group_core["Document Processing"]
  node_engine["Core engine<br/>[Engine.java]"]
  node_source["PDF source"]
  node_document["Document structure<br/>[Document.java]"]
  node_parsers["Parser registry<br/>[EngineParsers.java]"]
  node_tei["TEI output<br/>[TEIFormatter.java]"]
end

subgraph group_recognition["Extraction Models"]
  node_segmentation["Document segmentation<br/>[Segmentation.java]"]
  node_header["Header parsing<br/>[HeaderParser.java]"]
  node_fulltext["Full-text parsing"]
  node_references["Reference parsing"]
  node_reference_extract["Reference extraction"]
  node_patent["Patent references"]
  node_funding["Funding extraction"]
  node_license["License recognition"]
end

subgraph group_extensions["Resolution and Training"]
  node_consolidation["Metadata resolution<br/>[Consolidation.java]"]
  node_crossref["Crossref client"]
  node_glutton["Glutton client<br/>[GluttonClient.java]"]
  node_trainer["Training and evaluation"]
end

node_client(("Document client"))
node_pdfalto["pdfalto"]

node_client -.->|"submits document"| node_rest
node_rest -->|"delegates processing"| node_fileproc
node_fileproc -.->|"invokes engine"| node_engine
node_engine -->|"loads PDF source"| node_source
node_engine -->|"processes document"| node_document
node_engine -->|"uses parser registry"| node_parsers
node_parsers -->|"provides parser"| node_segmentation
node_parsers -->|"provides parser"| node_header
node_parsers -->|"provides parser"| node_fulltext
node_parsers -.->|"provides parser"| node_references
node_parsers -->|"provides parser"| node_reference_extract
node_parsers -->|"provides extractor"| node_patent
node_parsers -.->|"provides parser"| node_funding
node_parsers -.->|"provides classifier"| node_license
node_engine -.->|"emits TEI"| node_tei
node_engine -->|"resolves metadata"| node_consolidation
node_consolidation -.->|"queries Crossref"| node_crossref
node_consolidation -.->|"queries Glutton"| node_glutton
node_trainer -.->|"evaluates models"| node_engine
node_pdfalto -.->|"provides PDF layout"| node_source

click node_rest "https://github.com/grobidorg/grobid/blob/master/grobid-service/src/main/java/org/grobid/service/GrobidRestService.java"
click node_fileproc "https://github.com/grobidorg/grobid/blob/master/grobid-service/src/main/java/org/grobid/service/process/GrobidRestProcessFiles.java"
click node_engine "https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/engines/Engine.java"
click node_source "https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/document/DocumentSource.java"
click node_document "https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/document/Document.java"
click node_parsers "https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/engines/EngineParsers.java"
click node_segmentation "https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/engines/Segmentation.java"
click node_header "https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/engines/HeaderParser.java"
click node_fulltext "https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/engines/FullTextParser.java"
click node_references "https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/engines/CitationParser.java"
click node_reference_extract "https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/engines/ReferenceSegmenterParser.java"
click node_patent "https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/engines/patent/ReferenceExtractor.java"
click node_funding "https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/engines/FundingAcknowledgementParser.java"
click node_license "https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/engines/LicenseClassifier.java"
click node_tei "https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/document/TEIFormatter.java"
click node_consolidation "https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/utilities/Consolidation.java"
click node_crossref "https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/utilities/crossref/CrossrefClient.java"
click node_glutton "https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/utilities/glutton/GluttonClient.java"
click node_trainer "https://github.com/grobidorg/grobid/tree/master/grobid-trainer/src/main/java/org/grobid/trainer"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_rest,node_fileproc,node_client toneBlue
class node_engine,node_source,node_document,node_parsers,node_tei toneAmber
class node_segmentation,node_header,node_fulltext,node_references,node_reference_extract,node_patent,node_funding,node_license toneMint
class node_consolidation,node_crossref,node_glutton,node_trainer toneRose
class node_pdfalto toneIndigo
```

## Components

### Service API

- [REST endpoints](https://github.com/grobidorg/grobid/blob/master/grobid-service/src/main/java/org/grobid/service/GrobidRestService.java): `grobid-service/src/main/java/org/grobid/service/GrobidRestService.java`
- [File processing](https://github.com/grobidorg/grobid/blob/master/grobid-service/src/main/java/org/grobid/service/process/GrobidRestProcessFiles.java): `grobid-service/src/main/java/org/grobid/service/process/GrobidRestProcessFiles.java`

### Document Processing

- [Core engine](https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/engines/Engine.java): `grobid-core/src/main/java/org/grobid/core/engines/Engine.java`
- [PDF source](https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/document/DocumentSource.java): `grobid-core/src/main/java/org/grobid/core/document/DocumentSource.java`
- [Document structure](https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/document/Document.java): `grobid-core/src/main/java/org/grobid/core/document/Document.java`
- [Parser registry](https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/engines/EngineParsers.java): `grobid-core/src/main/java/org/grobid/core/engines/EngineParsers.java`
- [TEI output](https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/document/TEIFormatter.java): `grobid-core/src/main/java/org/grobid/core/document/TEIFormatter.java`

### Extraction Models

- [Document segmentation](https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/engines/Segmentation.java): `grobid-core/src/main/java/org/grobid/core/engines/Segmentation.java`
- [Header parsing](https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/engines/HeaderParser.java): `grobid-core/src/main/java/org/grobid/core/engines/HeaderParser.java`
- [Full-text parsing](https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/engines/FullTextParser.java): `grobid-core/src/main/java/org/grobid/core/engines/FullTextParser.java`
- [Reference parsing](https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/engines/CitationParser.java): `grobid-core/src/main/java/org/grobid/core/engines/CitationParser.java`
- [Reference extraction](https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/engines/ReferenceSegmenterParser.java): `grobid-core/src/main/java/org/grobid/core/engines/ReferenceSegmenterParser.java`
- [Patent references](https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/engines/patent/ReferenceExtractor.java): `grobid-core/src/main/java/org/grobid/core/engines/patent/ReferenceExtractor.java`
- [Funding extraction](https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/engines/FundingAcknowledgementParser.java): `grobid-core/src/main/java/org/grobid/core/engines/FundingAcknowledgementParser.java`
- [License recognition](https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/engines/LicenseClassifier.java): `grobid-core/src/main/java/org/grobid/core/engines/LicenseClassifier.java`

### Resolution and Training

- [Metadata resolution](https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/utilities/Consolidation.java): `grobid-core/src/main/java/org/grobid/core/utilities/Consolidation.java`
- [Crossref client](https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/utilities/crossref/CrossrefClient.java): `grobid-core/src/main/java/org/grobid/core/utilities/crossref/CrossrefClient.java`
- [Glutton client](https://github.com/grobidorg/grobid/blob/master/grobid-core/src/main/java/org/grobid/core/utilities/glutton/GluttonClient.java): `grobid-core/src/main/java/org/grobid/core/utilities/glutton/GluttonClient.java`
- [Training and evaluation](https://github.com/grobidorg/grobid/tree/master/grobid-trainer/src/main/java/org/grobid/trainer): `grobid-trainer/src/main/java/org/grobid/trainer`

### Other components

- **Document client**
- **pdfalto**

## Connections

- Document client → REST endpoints: submits document
- REST endpoints → File processing: delegates processing (evidence: `grobid-service/src/main/java/org/grobid/service/GrobidRestService.java`)
- File processing → Core engine: invokes engine
- Core engine → PDF source: loads PDF source (evidence: `grobid-core/src/main/java/org/grobid/core/engines/Engine.java`)
- Core engine → Document structure: processes document (evidence: `grobid-core/src/main/java/org/grobid/core/engines/Engine.java`)
- Core engine → Parser registry: uses parser registry (evidence: `grobid-core/src/main/java/org/grobid/core/engines/Engine.java`)
- Parser registry → Document segmentation: provides parser (evidence: `grobid-core/src/main/java/org/grobid/core/engines/EngineParsers.java`)
- Parser registry → Header parsing: provides parser (evidence: `grobid-core/src/main/java/org/grobid/core/engines/EngineParsers.java`)
- Parser registry → Full-text parsing: provides parser (evidence: `grobid-core/src/main/java/org/grobid/core/engines/EngineParsers.java`)
- Parser registry → Reference parsing: provides parser (evidence: `grobid-core/src/main/java/org/grobid/core/engines/EngineParsers.java`)
- Parser registry → Reference extraction: provides parser (evidence: `grobid-core/src/main/java/org/grobid/core/engines/EngineParsers.java`)
- Parser registry → Patent references: provides extractor (evidence: `grobid-core/src/main/java/org/grobid/core/engines/EngineParsers.java`)
- Parser registry → Funding extraction: provides parser (evidence: `grobid-core/src/main/java/org/grobid/core/engines/EngineParsers.java`)
- Parser registry → License recognition: provides classifier
- Core engine → TEI output: emits TEI
- Core engine → Metadata resolution: resolves metadata (evidence: `grobid-core/src/main/java/org/grobid/core/engines/Engine.java`)
- Metadata resolution → Crossref client: queries Crossref
- Metadata resolution → Glutton client: queries Glutton
- Training and evaluation → Core engine: evaluates models
- pdfalto → PDF source: provides PDF layout
