Skip to content
This repository has been archived by the owner on Feb 19, 2024. It is now read-only.

Commit

Permalink
📝 update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@kba
kba committed Nov 29, 2019
1 parent 0793e61 commit a08366f
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
2 changes: 2 additions & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,5 @@ __pycache__
tests/assets
repo/assets
tests/test-params.json
/build
/dist
18 changes: 14 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,15 @@

> Typegroups classifier for OCR
## Quick setup
## Installation

### From PyPI

```sh
pip3 install ocrd_typegroup_classifier
```

### From source

If needed, create a virtual environment for Python 3 (it was tested
successfully with Python 3.7), activate it, and install ocrd.
Expand All @@ -14,13 +22,15 @@ pip3 install ocrd
```

Enter in the folder containing the tool:
```cd ocrd_typegroups_classifier/```

```
cd ocrd_typegroups_classifier/
```

Install the module and its dependencies

```
make install
make deps
```

Finally, run the test:
Expand Down Expand Up @@ -48,4 +58,4 @@ to classification results. Syntax:

```
python3 tools/heatmap.py ocrd_typegroups_classifier/models/classifier.tgc sample.jpg out
```
```

0 comments on commit a08366f

Please sign in to comment.