Skip to content

Commit

Permalink
TLDR-455 change README and fixed 3.1, 3.3.4, 3.3.3 notes of FOND
Browse files Browse the repository at this point in the history
  • Loading branch information
oksidgy committed Sep 4, 2023
1 parent 4e50d4e commit 9d3ee39
Showing 1 changed file with 34 additions and 9 deletions.
43 changes: 34 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,21 @@ In 2022, the system won a grant to support the development of promising AI proje
* Using Tesseract, an actively developed OCR engine from Google, together with image preprocessing methods.
* Utilizing modern machine learning approaches for detecting a document orientation, detecting single/multicolumn document page, detecting bold text and extracting hierarchical structure based on the classification of features extracted from document images.


## Impact
This project may be useful as a first step of automatic document analysis pipeline (e.g. before the NLP part).
Dedoc is in demand for information analytic systems, information leak monitoring systems, as well as for natural language processing systems.
The library is intended for application use by developers of systems for automatic analysis and structuring of electronic documents, including for further search in electronic documents.

# Online-Documentation go [here]((https://dedoc.readthedocs.io/en/latest/))

# Installation instructions
This project has REST Api and you can run it in Docker container.
Also, dedoc can be installed as a library via `pip`.
To read full Dedoc documentation go [here](https://dedoc.readthedocs.io).


## Run the project
# Install and run

### Install and run dedoc using docker
## Install and run dedoc using docker

Clone the project
```bash
Expand All @@ -62,11 +66,32 @@ test="true" docker-compose up --build
```

Now you can go to the `localhost:1231` and look at the docs and examples.
You can change the port and host in the config file `dedoc/config.py`.

### Install dedoc using pip

One may install the dedoc library via `pip`.
### Option: You can change the port of service:
you need to change environment DOCREADER_PORT
1. For local service launching on your_port (1166 example):
```bash
export DOCREADER_PORT=1166
python dedoc/main.py -c ./dedoc/config.py
```
2. For service launching in docker-container you need to change port value in DOCREADER_PORT env and field 'ports' in docker-compose.yml file:
```yaml
...
dedoc:
...
ports:
- your_port_number:your_port_number
environment:
DOCREADER_PORT: your_port_number
...
test:
...
environment:
DOCREADER_PORT: your_port_number
```
## Install dedoc using pip
One can install the dedoc library via `pip`.
To fulfil all the library requirements, you should have `torch~=1.11.0` and `torchvision~=0.12.0` installed.
You can install suitable for you versions of these libraries and install dedoc using `pip` command:

Expand Down

0 comments on commit 9d3ee39

Please sign in to comment.