[demo] Automate doctr demo update via CI job #2798

Workflow file for this run

.github/workflows/references.yml at 2d16bbf

	name: references

	on:
	push:
	branches: main
	pull_request:
	branches: main

	jobs:
	train-char-classification:
	runs-on: ${{ matrix.os }}
	strategy:
	fail-fast: false
	matrix:
	os: [ubuntu-latest]
	python: ["3.9"]
	framework: [tensorflow, pytorch]
	steps:
	- uses: actions/checkout@v4
	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: ${{ matrix.python }}
	architecture: x64
	- if: matrix.framework == 'tensorflow'
	name: Cache python modules (TF)
	uses: actions/cache@v4
	with:
	path: ~/.cache/pip
	key: ${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements.txt') }}-${{ hashFiles('references/requirements.txt') }}
	restore-keys: \|
	${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements.txt') }}-
	- if: matrix.framework == 'pytorch'
	name: Cache python modules (PT)
	uses: actions/cache@v4
	with:
	path: ~/.cache/pip
	key: ${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements-pt.txt') }}-${{ hashFiles('references/requirements.txt') }}
	restore-keys: \|
	${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements-pt.txt') }}-
	- if: matrix.framework == 'tensorflow'
	name: Install dependencies (TF)
	run: \|
	python -m pip install --upgrade pip
	pip install -e .[tf,viz,html] --upgrade
	pip install -r references/requirements.txt
	sudo apt-get update && sudo apt-get install fonts-freefont-ttf -y
	- if: matrix.framework == 'pytorch'
	name: Install dependencies (PT)
	run: \|
	python -m pip install --upgrade pip
	pip install -e .[torch,viz,html] --upgrade
	pip install -r references/requirements.txt
	sudo apt-get update && sudo apt-get install fonts-freefont-ttf -y
	- if: matrix.framework == 'tensorflow'
	name: Train for a short epoch (TF)
	run: python references/classification/train_tensorflow_character.py vit_s -b 32 --val-samples 1 --train-samples 1 --epochs 1
	- if: matrix.framework == 'pytorch'
	name: Train for a short epoch (PT)
	run: python references/classification/train_pytorch_character.py vit_s -b 32 --val-samples 1 --train-samples 1 --epochs 1

	train-orientation-classification:
	runs-on: ${{ matrix.os }}
	strategy:
	fail-fast: false
	matrix:
	os: [ubuntu-latest]
	python: ["3.9"]
	framework: [tensorflow, pytorch]
	steps:
	- uses: actions/checkout@v4
	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: ${{ matrix.python }}
	architecture: x64
	- if: matrix.framework == 'tensorflow'
	name: Cache python modules (TF)
	uses: actions/cache@v4
	with:
	path: ~/.cache/pip
	key: ${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements.txt') }}-${{ hashFiles('references/requirements.txt') }}
	restore-keys: \|
	${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements.txt') }}-
	- if: matrix.framework == 'pytorch'
	name: Cache python modules (PT)
	uses: actions/cache@v4
	with:
	path: ~/.cache/pip
	key: ${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements-pt.txt') }}-${{ hashFiles('references/requirements.txt') }}
	restore-keys: \|
	${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements-pt.txt') }}-
	- if: matrix.framework == 'tensorflow'
	name: Install dependencies (TF)
	run: \|
	python -m pip install --upgrade pip
	pip install -e .[tf,viz,html] --upgrade
	pip install -r references/requirements.txt
	- if: matrix.framework == 'pytorch'
	name: Install dependencies (PT)
	run: \|
	python -m pip install --upgrade pip
	pip install -e .[torch,viz,html] --upgrade
	pip install -r references/requirements.txt
	- name: Download and extract detection toy set
	run: \|
	wget https://github.com/mindee/doctr/releases/download/v0.3.1/toy_detection_set-bbbb4243.zip
	sudo apt-get update && sudo apt-get install unzip -y
	unzip toy_detection_set-bbbb4243.zip -d det_set
	- name: Download and extract recognition toy set
	run: \|
	wget https://github.com/mindee/doctr/releases/download/v0.3.1/toy_recogition_set-036a4d80.zip
	sudo apt-get update && sudo apt-get install unzip -y
	unzip toy_recogition_set-036a4d80.zip -d reco_set
	- if: matrix.framework == 'tensorflow'
	name: Train for a short epoch (TF) (document orientation)
	run: python references/classification/train_tensorflow_orientation.py ./det_set ./det_set resnet18 page -b 2 --epochs 1
	- if: matrix.framework == 'pytorch'
	name: Train for a short epoch (PT) (document orientation)
	run: python references/classification/train_pytorch_orientation.py ./det_set ./det_set resnet18 page -b 2 --epochs 1
	- if: matrix.framework == 'tensorflow'
	name: Train for a short epoch (TF) (crop orientation)
	run: python references/classification/train_tensorflow_orientation.py ./reco_set ./reco_set resnet18 crop -b 4 --epochs 1
	- if: matrix.framework == 'pytorch'
	name: Train for a short epoch (PT) (crop orientation)
	run: python references/classification/train_pytorch_orientation.py ./reco_set ./reco_set resnet18 crop -b 4 --epochs 1

	train-text-recognition:
	runs-on: ${{ matrix.os }}
	strategy:
	fail-fast: false
	matrix:
	os: [ubuntu-latest]
	python: ["3.9"]
	framework: [tensorflow, pytorch]
	steps:
	- uses: actions/checkout@v4
	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: ${{ matrix.python }}
	architecture: x64
	- if: matrix.framework == 'tensorflow'
	name: Cache python modules (TF)
	uses: actions/cache@v4
	with:
	path: ~/.cache/pip
	key: ${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements.txt') }}-${{ hashFiles('references/requirements.txt') }}
	restore-keys: \|
	${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements.txt') }}-
	- if: matrix.framework == 'pytorch'
	name: Cache python modules (PT)
	uses: actions/cache@v4
	with:
	path: ~/.cache/pip
	key: ${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements-pt.txt') }}-${{ hashFiles('references/requirements.txt') }}
	restore-keys: \|
	${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements-pt.txt') }}-
	- if: matrix.framework == 'tensorflow'
	name: Install dependencies (TF)
	run: \|
	python -m pip install --upgrade pip
	pip install -e .[tf,viz,html] --upgrade
	pip install -r references/requirements.txt
	- if: matrix.framework == 'pytorch'
	name: Install dependencies (PT)
	run: \|
	python -m pip install --upgrade pip
	pip install -e .[torch,viz,html] --upgrade
	pip install -r references/requirements.txt
	- name: Download and extract toy set
	run: \|
	wget https://github.com/mindee/doctr/releases/download/v0.3.1/toy_recogition_set-036a4d80.zip
	sudo apt-get update && sudo apt-get install unzip -y
	unzip toy_recogition_set-036a4d80.zip -d reco_set
	- if: matrix.framework == 'tensorflow'
	name: Train for a short epoch (TF)
	run: python references/recognition/train_tensorflow.py crnn_vgg16_bn --train_path ./reco_set --val_path ./reco_set -b 4 --epochs 1
	- if: matrix.framework == 'pytorch'
	name: Train for a short epoch (PT)
	run: python references/recognition/train_pytorch.py crnn_mobilenet_v3_small --train_path ./reco_set --val_path ./reco_set -b 4 --epochs 1

	evaluate-text-recognition:
	runs-on: ${{ matrix.os }}
	strategy:
	fail-fast: false
	matrix:
	os: [ubuntu-latest]
	python: ["3.9"]
	framework: [tensorflow, pytorch]
	steps:
	- uses: actions/checkout@v4
	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: ${{ matrix.python }}
	architecture: x64
	- if: matrix.framework == 'tensorflow'
	name: Cache python modules (TF)
	uses: actions/cache@v4
	with:
	path: ~/.cache/pip
	key: ${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements.txt') }}
	- if: matrix.framework == 'pytorch'
	name: Cache python modules (PT)
	uses: actions/cache@v4
	with:
	path: ~/.cache/pip
	key: ${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements-pt.txt') }}
	- if: matrix.framework == 'tensorflow'
	name: Install dependencies (TF)
	run: \|
	python -m pip install --upgrade pip
	pip install -e .[tf,viz,html] --upgrade
	- if: matrix.framework == 'pytorch'
	name: Install dependencies (PT)
	run: \|
	python -m pip install --upgrade pip
	pip install -e .[torch,viz,html] --upgrade
	- if: matrix.framework == 'tensorflow'
	name: Evaluate text recognition (TF)
	run: python references/recognition/evaluate_tensorflow.py crnn_mobilenet_v3_small --dataset IIIT5K -b 32
	- if: matrix.framework == 'pytorch'
	name: Evaluate text recognition (PT)
	run: python references/recognition/evaluate_pytorch.py crnn_mobilenet_v3_small --dataset IIIT5K -b 32

	latency-text-recognition:
	runs-on: ${{ matrix.os }}
	strategy:
	fail-fast: false
	matrix:
	os: [ubuntu-latest]
	python: ["3.9"]
	framework: [tensorflow, pytorch]
	steps:
	- uses: actions/checkout@v4
	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: ${{ matrix.python }}
	architecture: x64
	- if: matrix.framework == 'tensorflow'
	name: Cache python modules (TF)
	uses: actions/cache@v4
	with:
	path: ~/.cache/pip
	key: ${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements.txt') }}
	- if: matrix.framework == 'pytorch'
	name: Cache python modules (PT)
	uses: actions/cache@v4
	with:
	path: ~/.cache/pip
	key: ${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements-pt.txt') }}
	- if: matrix.framework == 'tensorflow'
	name: Install dependencies (TF)
	run: \|
	python -m pip install --upgrade pip
	pip install -e .[tf,viz,html] --upgrade
	- if: matrix.framework == 'pytorch'
	name: Install dependencies (PT)
	run: \|
	python -m pip install --upgrade pip
	pip install -e .[torch,viz,html] --upgrade
	- if: matrix.framework == 'tensorflow'
	name: Benchmark latency (TF)
	run: python references/recognition/latency_tensorflow.py crnn_mobilenet_v3_small --it 5
	- if: matrix.framework == 'pytorch'
	name: Benchmark latency (PT)
	run: python references/recognition/latency_pytorch.py crnn_mobilenet_v3_small --it 5

	train-text-detection:
	runs-on: ${{ matrix.os }}
	strategy:
	fail-fast: false
	matrix:
	os: [ubuntu-latest]
	python: ["3.9"]
	framework: [tensorflow, pytorch]
	steps:
	- uses: actions/checkout@v4
	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: ${{ matrix.python }}
	architecture: x64
	- if: matrix.framework == 'tensorflow'
	name: Cache python modules (TF)
	uses: actions/cache@v4
	with:
	path: ~/.cache/pip
	key: ${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements.txt') }}-${{ hashFiles('references/requirements.txt') }}
	restore-keys: \|
	${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements.txt') }}-
	- if: matrix.framework == 'pytorch'
	name: Cache python modules (PT)
	uses: actions/cache@v4
	with:
	path: ~/.cache/pip
	key: ${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements-pt.txt') }}-${{ hashFiles('references/requirements.txt') }}
	restore-keys: \|
	${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements-pt.txt') }}-
	- if: matrix.framework == 'tensorflow'
	name: Install dependencies (TF)
	run: \|
	python -m pip install --upgrade pip
	pip install -e .[tf,viz,html] --upgrade
	pip install -r references/requirements.txt
	- if: matrix.framework == 'pytorch'
	name: Install dependencies (PT)
	run: \|
	python -m pip install --upgrade pip
	pip install -e .[torch,viz,html] --upgrade
	pip install -r references/requirements.txt
	- name: Download and extract toy set
	run: \|
	wget https://github.com/mindee/doctr/releases/download/v0.3.1/toy_detection_set-bbbb4243.zip
	sudo apt-get update && sudo apt-get install unzip -y
	unzip toy_detection_set-bbbb4243.zip -d det_set
	- if: matrix.framework == 'tensorflow'
	name: Train for a short epoch (TF)
	run: python references/detection/train_tensorflow.py --train_path ./det_set --val_path ./det_set linknet_resnet18 -b 2 --epochs 1
	- if: matrix.framework == 'pytorch'
	name: Train for a short epoch (PT)
	run: python references/detection/train_pytorch.py ./det_set ./det_set db_mobilenet_v3_large -b 2 --epochs 1

	evaluate-text-detection:
	runs-on: ${{ matrix.os }}
	strategy:
	fail-fast: false
	matrix:
	os: [ubuntu-latest]
	python: ["3.9"]
	framework: [tensorflow, pytorch]
	steps:
	- uses: actions/checkout@v4
	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: ${{ matrix.python }}
	architecture: x64
	- if: matrix.framework == 'tensorflow'
	name: Cache python modules (TF)
	uses: actions/cache@v4
	with:
	path: ~/.cache/pip
	key: ${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements.txt') }}
	- if: matrix.framework == 'pytorch'
	name: Cache python modules (PT)
	uses: actions/cache@v4
	with:
	path: ~/.cache/pip
	key: ${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements-pt.txt') }}
	- if: matrix.framework == 'tensorflow'
	name: Install dependencies (TF)
	run: \|
	python -m pip install --upgrade pip
	pip install -e .[tf,viz,html] --upgrade
	pip install -r references/requirements.txt
	- if: matrix.framework == 'pytorch'
	name: Install dependencies (PT)
	run: \|
	python -m pip install --upgrade pip
	pip install -e .[torch,viz,html] --upgrade
	pip install -r references/requirements.txt
	- if: matrix.framework == 'tensorflow'
	name: Evaluate text detection (TF)
	run: python references/detection/evaluate_tensorflow.py db_mobilenet_v3_large
	- if: matrix.framework == 'pytorch'
	name: Evaluate text detection (PT)
	run: python references/detection/evaluate_pytorch.py db_mobilenet_v3_large

	latency-text-detection:
	runs-on: ${{ matrix.os }}
	strategy:
	fail-fast: false
	matrix:
	os: [ubuntu-latest]
	python: ["3.9"]
	framework: [tensorflow, pytorch]
	steps:
	- uses: actions/checkout@v4
	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: ${{ matrix.python }}
	architecture: x64
	- if: matrix.framework == 'tensorflow'
	name: Cache python modules (TF)
	uses: actions/cache@v4
	with:
	path: ~/.cache/pip
	key: ${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements.txt') }}
	- if: matrix.framework == 'pytorch'
	name: Cache python modules (PT)
	uses: actions/cache@v4
	with:
	path: ~/.cache/pip
	key: ${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('requirements-pt.txt') }}
	- if: matrix.framework == 'tensorflow'
	name: Install dependencies (TF)
	run: \|
	python -m pip install --upgrade pip
	pip install -e .[tf,viz,html] --upgrade
	- if: matrix.framework == 'pytorch'
	name: Install dependencies (PT)
	run: \|
	python -m pip install --upgrade pip
	pip install -e .[torch,viz,html] --upgrade
	- if: matrix.framework == 'tensorflow'
	name: Benchmark latency (TF)
	run: python references/detection/latency_tensorflow.py db_mobilenet_v3_large --it 5 --size 512
	- if: matrix.framework == 'pytorch'
	name: Benchmark latency (PT)
	run: python references/detection/latency_pytorch.py db_mobilenet_v3_large --it 5 --size 512

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[demo] Automate doctr demo update via CI job #2798

Workflow file

[demo] Automate doctr demo update via CI job #2798

Jobs

Run details

Workflow file for this run