From b427945504aba63ffd42782fd53560e5ab9b36af Mon Sep 17 00:00:00 2001 From: Luan Pham Date: Tue, 21 Jun 2022 18:43:43 +0700 Subject: [PATCH] Add TOC --- README.md | 34 ++++++++++++++++++++++++++-------- 1 file changed, 26 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 7816ca4..5e81167 100644 --- a/README.md +++ b/README.md @@ -10,26 +10,42 @@ ![example workflow](https://github.com/phamquiluan/jdeskew/actions/workflows/docker-build-and-push.yml/badge.svg) ![example workflow](https://github.com/phamquiluan/jdeskew/actions/workflows/python-publish.yml/badge.svg) - ![Cover Image](https://user-images.githubusercontent.com/24642166/165683091-4091bb3c-6625-4180-93b6-86deec9a0750.gif) -## I. Installation +**Table of Contents** +- [Document Image Skew Estimation](#document-image-skew-estimation) + * [Installation](#installation) + + [pip](#pip) + + [Docker](#docker) + * [How-to-use](#how-to-use) + + [using python](#using-python) + + [using cog](#using-cog) + * [Performance Comparison on DISE 2021](#performance-comparison-on-dise-2021) + * [DISE 2021 Dataset](#dise-2021-dataset) + * [Reproducibility and Evaluation Code](#reproducibility-and-evaluation-code) + * [Citation](#citation) + +Table of contents generated with markdown-toc + -### I.1. pip + +## Installation + +### pip ```bash pip install jdeskew ``` -### I.2. Docker +### Docker ```bash docker pull phamquiluan/jdeskew ``` -## II. How-to-use +## How-to-use -### II.1. using python +### using python ```python from jdeskew.estimator import get_angle @@ -39,7 +55,9 @@ from jdeskew.utility import rotate output_image = rotate(image, angle) ``` -### II.2. using [cog](https://github.com/replicate/cog) +### using cog + +https://github.com/replicate/cog ```bash cog build --debug @@ -84,7 +102,7 @@ This datasets are built upon three other datasets: DISEC 2013, RVL, RDCL. So I u | DISE 2021 (45 degree) | https://drive.google.com/file/d/1a-a6aOqdsghjeHGLnCLsDs7NoJIus-Pw/view?usp=sharing | | DISE 2021 (15 degree) | https://drive.google.com/file/d/1BLiuu-j28dbuPFi4n3C0KuV6vXGmB0qS/view?usp=sharing | -## Reproducibility \& Evaluation Code +## Reproducibility and Evaluation Code Check the [reproduce.ipynb](reproduce.ipynb) file