README.md

AI-based web extractor

This repository contains source code of AI-based structured web data extractor.

• 👨‍💻 Author: Jan Joneš
• 📜 Thesis: PDF, assignment, submission, slides
• 🚀 Demo: live, Docker Hub, examples below
• 🗃️ Data: SWDE with visuals

Directory structure

• 📂 awe/: Python module (data manipulation and machine learning). See awe/README.md.
• 📂 js/: Node.js app (visual attribute extractor and inference demo). See js/README.md.
• 📂 docs/
  • 📂 dev/
    • 📄 env.md: development environment setup.
    • 📄 tips.md: development guidelines and bash snippets.
  • 📄 data.md: dataset preparation.
  • 📄 extractor.md: running the visual extractor.
  • 📄 train.md: training instructions.
  • 📄 release.md: release instructions.
  • 📂 demo/
    • 📄 run.md: developing and running the demo.
    • 📄 deploy.md: online demo deployment.

Quickstart

Running the pre-trained demo locally

docker pull janjones/awe-demo
docker run --rm -it -p 3000:3000 janjones/awe-demo

Open a web browser and navigate to http://localhost:3000/.

For more details, see docs/demo/run.md.

Training on the SWDE dataset

docker pull janjones/awe-gradient
docker run --rm -it -v awe:/storage -p 3000:3000 janjones/awe-gradient bash

Then, run inside the Docker container:

git clone https://github.com/jjonescz/awe .
git clone https://github.com/jjonescz/swde-visual data/swde
python -m awe.training.params
python -m awe.training.train
# Model is trained, now you can run the demo.
cd js
pnpm install
DEBUG=1 pnpm run server

For more details, see

1. docs/dev/env.md,
2. docs/data.md,
3. docs/train.md, and
4. docs/demo/run.md.

Examples

Generated by the live demo.