Skip to main content

A Benchmark for Information Extraction From Scientific Literature

Project description

LitXBench

PyPI LitXAlloy

LitXBench is a benchmark to evaluate LLMs on extracting material information synthesized in research papers. Read the preprint here.

LitXBench Principles for Accurate Extraction and Benchmarking. (1) To accurately capture a material’s properties, measurements must be linked to its processing lineage, rather than just its composition. (2) Categorical values should be mapped to canonical values to disambiguate similar values, as multiple papers may reference different properties with the same term. (3) Extracted materials are more editable and auditable when represented as code, reducing errors in the benchmark.

Installation

uv pip install litxbench

Usage

Loading Ground Truth

LitXBench ships with annotated ground-truth extractions. The litxalloy dataset contains 19 papers on high-entropy alloys.

from litxbench.litxalloy import papers

# papers is a dict mapping DOI strings to list[Experiment]
doi = "doi_10_3390__e21020122"
ground_truth = papers[doi]

Building Extractions

Represent extracted materials as Experiment objects. Each experiment contains raw materials, synthesis groups (with optional template variables), and output materials with their measurements.

from pymatgen.core.composition import Composition
from litxbench import (
    CompMeasurement, Configuration, CrysStruct, Experiment, Material,
    Measurement, ProcessEvent, ProcessKind, Quantity, RawMaterial, RawMaterialKind,
)
from litxbench.core.models import GlobalLatticeParam
from litxbench.core.units import Celsius, Hour, MegaPascal, Nanometer, gram_per_cm3, percent, HV
from litxbench.litxalloy.models import AlloyMeasurementKind

extracted = [
    Experiment(
        raw_materials={"elements": RawMaterial(kind=RawMaterialKind.Powder)},
        # Synthesis groups can use template variables (e.g. [Duration], [Temp])
        # that are substituted per-material via process strings.
        synthesis_groups={
            "Milling[Duration]": [
                ProcessEvent(
                    kind=ProcessKind.PlanetaryMilling,
                    duration=Quantity(value="[Duration]", unit=Hour),
                ),
            ],
            "SPS[Temp]": [
                ProcessEvent(
                    kind=ProcessKind.SparkPlasmaSintering,
                    temperature=Quantity(value="[Temp]", unit=Celsius),
                ),
            ],
        },
        output_materials=[
            # Named materials can be referenced as inputs by later materials
            Material(
                process="elements->Milling[Duration=60]",
                name="base",
                measurements=[
                    CompMeasurement(Composition("CoCrNiCuZn")),
                    GlobalLatticeParam(
                        struct=CrysStruct.BCC,
                        phase_fraction=Quantity(value=100, unit=percent),
                    ),
                    Measurement(
                        kind=AlloyMeasurementKind.crystallite_size,
                        value=13,
                        unit=Nanometer,
                    ),
                    Measurement(
                        kind=AlloyMeasurementKind.lattice_strain,
                        value=0.7,
                        unit=percent,
                    ),
                    # Configurations represent distinct phases within a material
                    Configuration(
                        name="Phase 1",
                        measurements=[
                            Measurement(kind=AlloyMeasurementKind.solidus, value=1244.8, unit=Celsius),
                        ],
                    ),
                ],
            ),
            # This material chains from "base" through the SPS synthesis group
            Material(
                process="base->SPS[Temp=900]",
                measurements=[
                    CompMeasurement(Composition("CoCrNiCuZn")),
                    Measurement(kind=AlloyMeasurementKind.density, value=7.89, unit=gram_per_cm3),
                    Measurement(kind=AlloyMeasurementKind.ultimate_compressive_strength, value=2121, unit=MegaPascal),
                    Measurement(kind=AlloyMeasurementKind.vickers_hardness, value=615, unit=HV),
                    GlobalLatticeParam(struct=CrysStruct.FCC, name="FCC1"),
                    GlobalLatticeParam(struct=CrysStruct.FCC, name="FCC2"),
                ],
            ),
        ],
    ),
]

Evaluating Extractions

Compare your extractions against the ground truth to get precision, recall, and F1 scores.

from litxbench import compare_experiments

result = compare_experiments(ground_truth, extracted)
print(f"Precision: {result.precision:.2%}")
print(f"Recall:    {result.recall:.2%}")
print(f"F1:        {result.f1:.2%}")

For multi-level metrics (value, process, configuration, and material levels):

from litxbench.core.eval import compute_multi_level_metrics

metrics = compute_multi_level_metrics(result)
print(f"Overall F1: {metrics.overall_f1:.2%}")
print(f"Value F1:   {metrics.value_f1:.2%}")
print(f"Process F1: {metrics.process_f1:.2%}")

A complete end-to-end example is available at examples/usage.py.

Paper Evaluation Scripts Warning

For the evaluation scripts used in the paper, LitXBench intructs LLMs to format the extracted materials as code. This code is run by LitXBench via Python exec. Do NOT call untrusted LLMs as they may generate untrusted code which could be executed on your machine.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

litxbench-0.1.1.tar.gz (14.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

litxbench-0.1.1-py3-none-any.whl (14.9 MB view details)

Uploaded Python 3

File details

Details for the file litxbench-0.1.1.tar.gz.

File metadata

  • Download URL: litxbench-0.1.1.tar.gz
  • Upload date:
  • Size: 14.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for litxbench-0.1.1.tar.gz
Algorithm Hash digest
SHA256 fb161402149c343c4f4d062ced61fe14c0b729554923b581f32498ad201e11c2
MD5 4236c5326696d961608d6b3d20e40759
BLAKE2b-256 52dec1a6e37940c7f4592783870af00819078a469a5fccea4fd1d80befd0e676

See more details on using hashes here.

File details

Details for the file litxbench-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: litxbench-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 14.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for litxbench-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3b21c6320af4d25428dba9818b93fc2942a1016336e4cc9ddec2ad4f265c6667
MD5 6b79192550bf89e8aa05fcb704478140
BLAKE2b-256 d18b089de6e2f5be23a11c4ef601c05aeaebf4a235a2db05b7edc4c8265a2d8f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page