Metadata-Version: 2.1
Name: lours
Version: 1.0.0
Summary: 
License: MIT
Author: Lilian Glaudin
Author-email: lilian.glaudin@xxii.fr
Requires-Python: >=3.10,<3.13
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Provides-Extra: fiftyone
Provides-Extra: plot-utils
Provides-Extra: regression
Requires-Dist: POT (>=0.9.1,<0.10.0)
Requires-Dist: PyYAML (>=6.0.1,<7.0.0)
Requires-Dist: boto3 (==1.26.83) ; extra == "fiftyone"
Requires-Dist: faker (>=29.0.0,<30.0.0)
Requires-Dist: fiftyone (>=0.25,<0.26) ; extra == "fiftyone"
Requires-Dist: fiftyone-db-ubuntu2204 (>=0.4.0,<0.5.0) ; sys_platform == "linux"
Requires-Dist: imageio (>=2.31.3,<3.0.0)
Requires-Dist: imagesize (>=1.4.1,<2.0.0)
Requires-Dist: jsonschema-rs (>=0.20.0,<0.21.0)
Requires-Dist: numpy (>=1,<2)
Requires-Dist: pandas (>=2.2.2,<3.0.0)
Requires-Dist: pyarrow (>=17.0.0,<18.0.0)
Requires-Dist: pytest-regressions (>=2.5.0,<3.0.0) ; extra == "regression"
Requires-Dist: scikit-learn (>=1.3.0,<2.0.0)
Requires-Dist: scipy (>=1,<1.14)
Requires-Dist: shortuuid (>=1.0.11,<2.0.0)
Requires-Dist: toml (>=0.10.2,<0.11.0)
Requires-Dist: tqdm (>=4.64,<5.0)
Requires-Dist: typing-extensions (>=4.7.1,<5.0.0)
Requires-Dist: watchdog (>=5.0.0,<6.0.0)
Requires-Dist: xmltodict (>=0.13.0,<0.14.0)
Description-Content-Type: text/markdown

# README

[![codecov](https://img.shields.io/codecov/c/gh/XXII-AI/lours?logo=codecov&color=cyan)](https://codecov.io/gh/XXII-AI/Lours) ![GitHub License](https://img.shields.io/github/license/XXII-AI/Lours?color=violet&logo=license) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/lours?logo=python)
 ![PyPI - Version](https://img.shields.io/pypi/v/lours?logo=pypi) ![PyPI - Downloads](https://img.shields.io/pypi/dm/lours?color=yellow) ![Read the Docs](https://img.shields.io/readthedocs/lours?logo=readthedocs&color=orange)

![logo lours](docs/_static/logo-title-readme.png)

Lours, the pandas companion

## DOC API

Sphinx docs is available here:

- [stable](https://lours.readthedocs.io/stable/)
- [latest](https://lours.readthedocs.io/latest/)

## Installation

```bash
pip install lours
```

You can also install the pre-release by adding the `--pre` option

```bash
pip install lours --pre
```

### From source

- `pip`

```bash
pip install -e . # Only for pip > 21.3
```

- `poetry >= 1.2`

Assuming both lours and your project are in the same folder, adapt the relative path of the repo if needed

```bash
poetry add --editable ../lours/
poetry add --editable https://github.com/XXII-AI/lours.git
```

## The dataset object

See <https://UPDATE-ME>

## Usage

```python
from lours.dataset import from_caipy, from_coco
dataset1 = from_caipy("path/to/caipy")
print(dataset1)
dataset2 = from_coco("path/to/coco", images_root="/path/to/coco_images")
dataset2 = dataset2.remap_from_preset("coco", "pascalvoc")
print(dataset2)
```

## Tutorials

See some notebooks in folder `docs/notebooks`

Alternatively, See <https://lours.readthedocs.io/stable/tutorials>

