Skip to content

Repository files navigation

Flowde

Tests Pre-commit Python Coverage

Flowde is a Python package for extracting structured data from flowcharts. Developed for CONSORT diagrams in systematic reviews, Flowde also supports other types of flowchart.

Open demo in Google Colab

Try the complete CONSORT workflow in your browser. The demo requires a Google account, an Azure OpenAI endpoint and an API key.

Read the documentation for setup, usage guides and the API reference.

Features

  • Extract candidate images from PDFs with PaddleOCR.
  • Classify images and keep the diagrams you need.
  • Rotate diagrams into the correct orientation.
  • Parse node text, labels, flow and additional text into structured JSON.
  • Benchmark classification, rotation and parsing against ground truth.

Use the full pipeline or individual stages, with OpenAI, Azure OpenAI, Gemini or your own processing functions. Flowde saves completed work and supports stopping and resuming runs. The package includes prompts and example data for CONSORT diagrams.

Installation

Requires Python 3.11 or later. To install all features with CPU extraction:

python -m pip install "flowde[all] @ git+https://github.com/EPPI-Centre/Flowde.git"

See the installation guide for individual features and GPU setup.

Documentation

  • Pipeline guide: work through extraction, classification, rotation and parsing.
  • CONSORT recipe: copy a complete workflow using the supplied prompts.
  • API reference: inspect functions, parameters and result types.
  • Example data: view the included studies and article licences.

For bug reports and feature requests, open an issue.

About

Extracting data from CONSORT flowcharts.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages