Skip to main content

data-extraction-evaluation-toolkit

The Data Extraction Evaluation Toolkit (DEET) is an open-source toolkit designed to support the development and evaluation of AI-assisted data extraction for evidence synthesis.

Extracting structured information from research studies is one of the most time-consuming stages of the evidence synthesis process. While large language models (LLMs) and other AI methods have the potential to reduce this workload, inaccurate extraction can introduce errors into reviews and ultimately affect evidence used for research and policy decisions. Robust evaluation is therefore essential to ensure that AI tools are reliable, transparent, and fit for purpose.

DEET provides an end-to-end, modular workflow for configuring, running and evaluating automated data extraction methods. It enables users to compare AI-generated outputs against human-created reference (gold standard) datasets, helping to assess the accuracy, consistency and performance of different approaches. Designed around open and FAIR (Findable, Accessible, Interoperable and Reusable) principles, DEET supports reproducible evaluation through reusable code, APIs and standardised data models.

DEET is intended for researchers, evidence synthesis teams, developers and organisations interested in evaluating or developing AI-enhanced evidence synthesis workflows. Users can expect structured extraction outputs, performance metrics and transparent evaluation results that support informed decisions about the use of AI in evidence synthesis.

Within DESTINY, DEET will be used to evaluate an AI-powered data extraction workflow for intervention studies. Researchers will compare data extracted automatically by a large language model with manually extracted reference data, identify where the AI performs well or makes errors, and use these results to improve extraction methods before they are incorporated into evidence synthesis workflows.

More detailed documentation can be found here Docs

Quickstart

deet is published on PyPI as destiny-deet.

To use the deet CLI

uv tool install destiny-deet
deet --help

To use deet as a package

uv add destiny-deet  # or: pip install destiny-deet

Optional extras are available for document parsing (destiny-deet[parsers]) and text quality checks (destiny-deet[lang-quality]).

To install the latest unreleased code instead, replace destiny-deet with git+https://github.com/destiny-evidence/data-extraction-evaluation-toolkit.git.

Using deet

The data-extraction-evaluation-toolkit (deet) contains mutliple modules which can be leveraged alone, or orchestrated together to form a Pipeline. The goal of DEET is to be modular and extensible, allowing users to customise a specific pipeline or workflow to their needs.

Typical pipelines can be run using the CLI app deet --help

Contributing

If you want to contribute to this project -- awesome, everyone's welcome. Please see the contributing guidelines for details on how best to contribute.

A few important steps when contributing:

pre-commit install
uv run pre-commit install --hook-type commit-msg

This will force you to use conventional commits.

Commit message format

All commits must use conventional commits. The pre-commit hook will reject any commit that doesn't.

prefix example version effect
fix: fix: handle null input patch: 0.1.0 -> 0.1.1
feat: feat: add login page minor: 0.1.0 -> 0.2.0
feat!: or BREAKING CHANGE: footer feat!: remove legacy api major: 0.1.0 -> 1.0.0
chore:, docs:, ci:, test: chore: update deps no bump

Tests

Tests are written using pytest. You can run the tests locally using

pytest

Unit tests are automatically run in Continuous Integration (CI) using github actions (see .github/workflows/tests.yml) on Pull Requests or merges into main or development. Integration tests are also run for pushes/PRs into main (Note: these will take approx 1-2h to complete, so consider a cup of coffee while you wait).

Adding documentation

Please add to the docs whenever you feel it would be useful. The docs are built using mkdocs and mix automatically-generated API documentation with more general documentation. An automatically generated html static site is built from the docs/ directory, and the API documentation is generated from docstrings in the code.

To add your own documentation, add markdown files to the docs/ directory and add these to the nav block in mkdocs.yml. To add API documentation, add docstrings to the code and ensure that the relevant modules are included in the nav block in mkdocs.yml.

To build the docs locally, make sure you have the docs dependencies installed by running

uv sync --all-extras --all-groups

which will install the documentation dependencies alongside all other dependencies, including developer dependencies. Alternatively,

uv sync --group docs

will install only the documentation dependencies, but may uninstall other optional dependencies you have installed.

Then, from the root of the repository, run mkdocs serve --strict from the root of the repository and open the link that is printed to the terminal. The documentation website is currently automatically built and deployed to GitHub Pages on pushes to the main branch, and uses the gh-pages branch to serve the docs.

The documentation website is available at https://destiny-evidence.github.io/deet.

Citation

If you use deet in your work, please cite it as:

Finnerty Mutlu, A. N., Loynes, N., Uprety, S., Callaghan, M., Danilenko, D., Gopal, I., Hair, K., Molyneux, S., Moss, H., Repke, T., Schmidt, L., Soliman, N., Tezok, K. O. T. (Miyaka)., Vairon, J., & Thomas, J. (2026). Data Extraction Evaluation Toolkit (version 0.4.0-dev.2.) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.22897649

Acknowledgements

We acknowledge with thanks funding from the following funders and projects:

  • Digital Evidence Synthesis Tool INnovation for Yielding Improvements in Climate & Health (DESTINY) [313586/Z/24/Z]
  • Mobilising Evidence Through Artificial Intelligence and User-Informed Synthesis (METIUS) [UKRI3167]
  • Global Alliance for Living Evidence on aNxiety, depressiOn and pSychosis (GALENOS)
  • Living Evidence in Alzheimer's and Dementia (LEAD) [227443/Z/23/Z]
  • Education Endowment Foundation (EEF)

Metadata

Release files for destiny-deet 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for destiny-deet 0.5.0
File Size Uploaded
destiny_deet-0.5.0.tar.gz 133.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for destiny-deet 0.5.0
File Interpreter ABI Platform
destiny_deet-0.5.0-py3-none-any.whl Python 3 none any Details

Total release size: 289.7 kB

Release files / destiny_deet-0.5.0.tar.gz

Download URL destiny_deet-0.5.0.tar.gz
Size 133.9 kB
Tags Source
SHA-256 checksum
How to use checksums
01a71927b336a74a136683a5fe6122891f30aa1f2aad0e4eb6a67157208b5a6b
BLAKE2b-256 checksum
How to use checksums
84078038201e07f578e514aa51426066db10e75b52a732d22574a2ab48037940
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.21 {"installer":{"name":"uv","version":"0.12.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / destiny_deet-0.5.0-py3-none-any.whl

Download URL destiny_deet-0.5.0-py3-none-any.whl
Size 155.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
53dfe3c4543c65f072427629d079d01958b4a016d135fd0b5ba07e0e8af8e9a6
BLAKE2b-256 checksum
How to use checksums
8b9d448bd7a75cdb67a536069791b78fd26d60e1286218fdfa9d1a1d4cf743a6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.21 {"installer":{"name":"uv","version":"0.12.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release history Release notifications | RSS feed

This release

0.5.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page