Skip to content

Commit

Permalink
Release under new name docile-benchmark to avoid pypi collision
Browse files Browse the repository at this point in the history
  • Loading branch information
simsa-st authored and sulc committed Feb 28, 2023
1 parent f438ac1 commit 999c1a4
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ You can also work with the zipped datasets when you turn off image caching (chec
## Installation

### Option 1: Install as a library
To install just the library, download the wheel from the [latest release on github](https://github.com/rossumai/docile/releases) and run:
Install the library with:
```shell
pip install docile-0.1.0-py3-none-any.whl
pip install docile-benchmark
```

To convert pdfs into images, the library uses https://github.com/Belval/pdf2image. On linux you might need to install:
Expand All @@ -55,8 +55,8 @@ brew install poppler

Now you have all dependencies to work with the dataset annotations, pdfs, pre-comptued OCR and to run the evaluation. You can install extra dependencies by running the following (although using one of the provided dockerfiles, as explained below, might be easier in this case):
```shell
pip install "docile-0.1.0-py3-none-any.whl[interactive]"
pip install "docile-0.1.0-py3-none-any.whl[ocr]"
pip install "docile-benchmark[interactive]"
pip install "docile-benchmark[ocr]"
```

The first line installs additional dependencies allowing you to use the interactive dataset browser in [docile/tools/dataset_browser.py](docile/tools/dataset_browser.py) and the [tutorials](tutorials/). The second line let's you rerun the OCR predictions from scratch (e.g., if you'd like to run it with different parameters) but to make it work, you might need additional dependencies on your system. Check https://github.com/mindee/doctr for the installation instructions (for pytorch).
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "docile"
version = "0.2.1"
name = "docile-benchmark"
version = "0.2.2"
description = "Tools to work with the DocILE dataset and benchmark"
authors = [
"Stepan Simsa <stepan.simsa@rossum.ai>",
Expand Down

0 comments on commit 999c1a4

Please sign in to comment.