README.md

---
title: pipeline
app_file: engie_pipeline/app.py
sdk: gradio
sdk_version: 4.36.1
---
# Engie pipeline

---

### Installation

Python >=3.10 is required for the project. To install all the dependencies, simply run:

```shell
pip install -r requirements.txt
```

To download the needed model to run the pipeline, execute the following command:

```shell
bash download_model.sh
```

---

### Execution

To execute the pipeline, run the following command:

```shell
python -m engie_pipeline.pipeline
```

Change one or more parameter of the pipeline process with:
```shell
python -m engie_pipeline.pipeline with path="<path/to/file/or/folder>" output_path="<path/to/output/folder" conformity_threshold=0.8
```

if the `path` parameter is set to a folder, all the images found in the folder will be processed. The supported image types are ".jpg", ".jpeg", ".png"

### App

To launch the app, run:

```shell
python -m engie_pipeline.app
```