Metadata-Version: 2.4
Name: teklia-layout-reader
Version: 0.2.1
Summary: Scripts for Layout Reader
Author-email: Teklia <contact@teklia.com>
Maintainer-email: Teklia <contact@teklia.com>
License-Expression: MIT
Keywords: python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: teklia-toolbox==0.1.11
Requires-Dist: datasets==3.2.0
Requires-Dist: mdutils==1.6.0
Requires-Dist: prettytable==3.13.0
Requires-Dist: opencv-python-headless==4.12.0.88
Requires-Dist: matplotlib==3.10.6
Requires-Dist: deepspeed==0.18.1
Requires-Dist: trl==0.23.0
Requires-Dist: mpi4py==4.1.1
Requires-Dist: wandb==0.23.1
Requires-Dist: transformers==4.57.6
Requires-Dist: colour==0.1.5
Requires-Dist: accelerate==1.12.0

# Layout Reader

Scripts for Layout Reader

### Development

For development and tests purpose it may be useful to install the project as a editable package with pip.

* Use a virtualenv (e.g. with virtualenvwrapper `mkvirtualenv -a . layout-reader`)
* Install layout-reader as a package (e.g. `pip install -e .`)

### Linter

Code syntax is analyzed before submitting the code.\
To run the linter tools suite you may use pre-commit.

```shell
pip install pre-commit
pre-commit run -a
```

### Run tests

Tests are executed with `tox` using [pytest](https://pytest.org).

```shell
pip install tox
tox
```

To recreate tox virtual environment (e.g. a dependencies update), you may run `tox -r`.

Run a single test module: `tox -- <test_path>`
Run a single test: `tox -- <test_path>::<test_function>`
