quadra 0.0.1__tar.gz → 2.2.7__tar.gz

quadra-2.2.7/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2023] Orobix Srl
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

quadra-2.2.7/PKG-INFO

@@ -0,0 +1,381 @@
+Metadata-Version: 2.1
+Name: quadra
+Version: 2.2.7
+Summary: Deep Learning experiment orchestration library
+Home-page: https://orobix.github.io/quadra
+License: Apache-2.0
+Keywords: deep learning,experiment,lightning,hydra-core
+Author: Federico Belotti
+Author-email: federico.belotti@orobix.com
+Requires-Python: >=3.9,<3.11
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Provides-Extra: onnx
+Requires-Dist: albumentations (>=1.3,<1.4)
+Requires-Dist: anomalib-orobix (==0.7.0.dev143)
+Requires-Dist: boto3 (>=1.26,<1.27)
+Requires-Dist: grad-cam-orobix (==1.5.3.dev001)
+Requires-Dist: h5py (>=3.8,<3.9)
+Requires-Dist: hydra_colorlog (>=1.2,<1.3)
+Requires-Dist: hydra_core (>=1.3,<1.4)
+Requires-Dist: hydra_optuna_sweeper (>=1.2,<1.3)
+Requires-Dist: label_studio_converter (>=0.0,<0.1)
+Requires-Dist: matplotlib (>=3.6,<3.7)
+Requires-Dist: minio (>=7.1,<7.2)
+Requires-Dist: mlflow-skinny (>=2.3.1,<3.0.0)
+Requires-Dist: nvitop (>=0.11,<0.12)
+Requires-Dist: onnx (==1.15.0) ; extra == "onnx"
+Requires-Dist: onnxconverter-common (>=1.14.0,<2.0.0) ; extra == "onnx"
+Requires-Dist: onnxruntime_gpu (==1.17.0) ; extra == "onnx"
+Requires-Dist: onnxsim (==0.4.28) ; extra == "onnx"
+Requires-Dist: opencv_python_headless (>=4.7.0,<4.8.0)
+Requires-Dist: pandas (<2.0)
+Requires-Dist: pillow (>=9.3,<9.4)
+Requires-Dist: pydantic (==1.10.10)
+Requires-Dist: python_dotenv (>=0.21,<0.22)
+Requires-Dist: pytorch_lightning (>=2.1,<2.2)
+Requires-Dist: rich (>=13.2,<13.3)
+Requires-Dist: scikit_learn (>=1.2,<1.3)
+Requires-Dist: scikit_multilearn (>=0.2,<0.3)
+Requires-Dist: seaborn (>=0.12,<0.13)
+Requires-Dist: segmentation_models_pytorch-orobix (==0.3.3.dev1)
+Requires-Dist: tensorboard (>=2.11,<2.12)
+Requires-Dist: timm (==0.9.12)
+Requires-Dist: torch (==2.1.2)
+Requires-Dist: torchinfo (>=1.8,<1.9)
+Requires-Dist: torchmetrics (>=0.10,<0.11)
+Requires-Dist: torchsummary (>=1.5,<1.6)
+Requires-Dist: torchvision (>=0.16,<0.17)
+Requires-Dist: tripy (>=1.0,<1.1)
+Requires-Dist: typing_extensions (==4.11.0) ; python_version < "3.10"
+Requires-Dist: xxhash (>=3.2,<3.3)
+Project-URL: Repository, https://github.com/orobix/quadra
+Description-Content-Type: text/markdown
+
+<h1></h1>
+<p align="center">
+  <img src="https://github.com/orobix/quadra/raw/main/docs/images/quadra_text_logo.png" alt="Quadra Logo" width="100%">
+</p>
+
+<p align="center">
+  <a href="https://orobix.github.io/quadra/latest/index.html">Docs</a> •
+  <a href="https://orobix.github.io/quadra/latest/tutorials/datamodules.html">Tutorials</a> •
+  <a href="https://orobix.github.io/quadra/latest/tutorials/configurations.html">Configurations</a>
+</p>
+
+<div align="center">
+  <a href="https://github.com/astral-sh/ruff">
+    <img 
+    src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" 
+    alt="ruff"
+  ></a>
+  <a href="https://github.com/pre-commit/pre-commit"><img
+    src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white"
+    alt="pre-commit"
+  /></a>
+  <a href="https://github.com/econchick/interrogate"><img
+    src="https://github.com/orobix/quadra/raw/main/docs/images/interrogate_badge.svg"
+    alt="interrogate"
+  /></a>
+  <a href="https://github.com/PyCQA/pylint"><img
+    src="https://img.shields.io/badge/linting-pylint-yellowgreen"
+    alt="pylint"
+  /></a>
+  <a href="https://mypy-lang.org/"><img
+    src="https://www.mypy-lang.org/static/mypy_badge.svg"
+    alt="Checked with mypy"
+  /></a>
+
+</div>
+
+______________________________________________________________________
+
+
+`Quadra` aims to simplify deep learning experimenting process, allowing researchers or developers to compare, monitor, and share their experiments quickly. It provides a simple and flexible way to train and deploy deep learning models using YAML configuration files and open-source tools such as [Hydra](https://hydra.cc/docs/intro/), [Lightning](https://www.pytorchlightning.ai/index.html) framework, and [Pytorch](https://pytorch.org/). It lets you compose your experiment configurations from single command line interface, so you can conduct multiple experiments with different settings and hyperparameters. Every experiment can be logged using integrations provided by  [Lightning](https://www.pytorchlightning.ai/index.html) framework such [Mlflow](https://mlflow.org/).
+
+
+## Quick Start Guide
+
+If you use pip to manage your packages, you can install `quadra` from PyPi by running the following command:
+```shell
+pip install quadra
+```
+
+If instead you prefer to use poetry, you can install `quadra` from PyPi by running the following command:
+```shell
+poetry add quadra
+```
+
+If you don't have virtual environment ready, Let's set up our environment for using the `quadra` library. We have two parts in this guide: Common setup and Environment-specific setup.
+
+### Using Conda
+
+Create and activate a new `Conda` environment. 
+
+```shell
+conda create -n myenv python=3.10
+conda activate myenv
+```
+
+### Using Python Virtualenv
+
+Create and activate a new virtual environment.
+
+```shell
+# replace `myenv` with the name of your virtual environment
+python3 -m venv myenv
+source myenv/bin/activate
+```
+
+### Common Setup
+
+1. **Check your git version**: 
+  Make sure you have git version 2.10 or higher, to avoid any installation failures.
+  ```shell
+  git --version
+  ```
+
+2. **Upgrade pip**:
+  ```shell
+  pip install --upgrade pip
+  ```
+
+3. Install the package
+
+    * **Install the `quadra` package** with pip:
+      ```shell
+      pip install quadra
+      ```
+
+    * **Install the `quadra` package** with poetry:
+      ```shell
+      curl -sSL https://install.python-poetry.org | python3 -
+      poetry add quadra
+      ```
+
+4. **Run from CLI**:
+  Run the following command to check if the installation was successful:
+  ```shell
+  quadra experiment=default
+  ```
+
+### Setup `Mlflow` (Optional)
+
+To use Mlflow and leverage its functionalities such as saving models, logging metrics, saving artifacts, and visualizing results, you need to ensure that the Mlflow server is running. You can find more information about Mlflow [here](https://mlflow.org/).
+
+By default, the logger configuration is set to Mlflow, and experiments expect the `MLFLOW_TRACKING_URI` environment variable to be set to the address of the Mlflow server. There are two ways to set this variable:
+
+**Using the command line:**
+
+```
+export MLFLOW_TRACKING_URI=http://localhost:5000
+```
+This command sets the `MLFLOW_TRACKING_URI` variable to `http://localhost:5000`. Replace this with the actual address of your Mlflow server if it's running on a different host or port.
+
+**Adding it to your environment file:**
+
+`Quadra` uses environment variables to store credentials and other sensitive information. Thanks to [`python-dotenv`](https://pypi.org/project/python-dotenv/) library, you can create a `.env` file in the main folder of your project and store the credentials there. During the runtime, the library will automatically load the environment variables from the `.env` file. You can also add the `MLFLOW_TRACKING_URI` variable to your environment file (e.g., `.env`). Open the file in a text editor and add the following line:
+
+```
+MLFLOW_TRACKING_URI=http://localhost:5000
+```
+Again, modify the address if your Mlflow server is running on a different host or port.
+
+By setting the `MLFLOW_TRACKING_URI` variable using either method, you configure the logger to connect to the Mlflow server, enabling you to utilize its features effectively.
+
+The `export` command is specific to Unix-based systems like Linux or macOS. If you are using a different operating system, refer to the appropriate method for setting environment variables.
+
+## Run Example Experiments
+
+`quadra` provides a set of example experiments that can be used to test the installation and to provide some example configuration files.
+
+By default all the experiments will run on the `GPU 0`, to run it on the `CPU` you can specify a different `trainer` configuration parameter:
+
+```bash
+quadra <configurations> trainer=lightning_cpu
+```
+
+### Classification Training
+
+To run a simple classification training on the [Imagenette dataset](https://github.com/fastai/imagenette) with a Resnet18 architecture run the following command:
+
+```bash
+quadra experiment=generic/imagenette/classification/default logger=csv
+```
+
+This will train the model for 20 epochs and log the metrics in a csv file, at the end of the training a `torchscript` model will be saved for inference alongside some output images.
+
+By default the experiment will run on the GPU 0, to run it on the CPU you can specify a different `trainer` configuration parameter.
+
+
+### Segmentation Training
+
+To run a simple segmentation training on the [Oxford pet](https://www.robots.ox.ac.uk/~vgg/data/pets/) dataset with a Unet architecture run the following command:
+
+```bash
+quadra experiment=generic/oxford_pet/segmentation/smp logger=csv
+```
+
+This will make use of the [segmentation models pytorch](https://github.com/qubvel/segmentation_models.pytorch) library to train the model for 10 epochs, logging the metrics to a csv file. At the end of the training a torchscript model will be saved for inference alongside some output images.
+
+### (SSL) Self-supervised Learning Training
+
+On the same dataset we can run a simple SSL training using the BYOL algorithm with the following command:
+
+```bash
+quadra experiment=generic/imagenette/ssl/byol logger=csv
+```
+
+BYOL is not the only SSL algorithm available, you can find a list of all the available algorithms under `quadra/configs/experiment/generic/imagenette/ssl` folder.
+
+
+### Anomaly Detection Training
+
+To run a simple anomaly detection training on the [MNIST dataset](http://yann.lecun.com/exdb/mnist/) using the PADIM algorithm run the following command:
+
+```bash
+quadra experiment=generic/mnist/anomaly/padim logger=csv
+```
+
+This will run an anomaly detection considering on of the classes as good (default is the number 9) and the rest as anomalies.
+
+This will make use of the [anomalib](https://github.com/openvinotoolkit/anomalib) library to train the model. Many different algorithms are available, you can find them under `quadra/configs/experiment/generic/mnist/anomaly` folder.
+
+## Running with Custom Datasets
+
+Each task comes with a default configuration file that can be customized for your needs. Each example experiment we have seen so far uses a default configuration file that can be found under `quadra/configs/experiment/base/<task>/<config_name>.yaml`. 
+
+Let's see how we can customize the configuration file to run the classification experiment on a custom dataset.
+
+Structure your dataset in the following way:
+
+```tree
+dataset/
+├── class_1
+│   ├── abc.xyz
+│   └── ...
+├── class_2
+│   ├── abc.xyz
+│   └── ...
+├── class_3 
+│   ├── abc.xyz
+│   └── ...
+```
+
+Create a new experiment configuration file under `quadra/configs/experiment/custom/<config_name>.yaml` with the following content:
+
+```yaml
+# @package _global_
+defaults:
+  - base/classification/classification # extends the default classification configuration
+
+core:
+  name: <your-custom-experiment-name> # name of the experiment
+
+model:
+  num_classes: <number-of_classes-you-have> # number of classes in your dataset
+```
+
+Run the experiment with the following command:
+
+```bash
+quadra experiment=custom/<config_name> logger=csv
+```
+
+It will run the experiment using the configuration file you have just created and it will apply the default parameters from the classification configuration file. Furthermore, it will log the metrics to a csv file. You can add or customize the parameters in the configuration file to fit your needs.
+
+For more information about advanced usage, please check [tutorials](https://orobix.github.io/quadra/latest/tutorials/configurations.html) and [task specific examples](https://orobix.github.io/quadra/latest/tutorials/examples/classification.html).
+
+## Development
+
+First clone the repository from Github
+
+First clone the repository from `Github`, then we need to install the package with optional dependencies (generally in editable mode) and enable the pre-commit hooks.
+
+1. `git clone https://github.com/orobix/quadra.git && cd quadra` 
+2. Install poetry `curl -sSL https://install.python-poetry.org | python3 -`
+3. Install the required poetry plugins
+  ```
+  poetry self add poetry-bumpversion
+  poetry self add poetry-dotenv-plugin
+  ```
+4. Install `quadra` package in editable mode `poetry install --with test,dev,docs --all-extras`
+5. Install pre-commit hooks `pre-commit install`
+6. (Optional) Eventually build documentation by calling required commands (see below).
+
+Now you can start developing and the pre-commit hooks will run automatically to prevent you from committing code that does not pass the linting and formatting checks.
+
+We rely on a combination of `Pylint`, `Mypy` and `Ruff` to enforce code quality.
+
+## Building Documentations
+
+1. Activate your virtual environment.
+2. Install the `quadra` package with at least `doc` version.
+3. To run the webserver for real-time rendering and editing run `mkdocs serve` and visit `http://localhost:8000/`.
+4. If you want to export the static website to a specific folder  `mkdocs build -d <Destination Folder>`
+
+
+## Acknowledgements
+
+This project is based on many open-source libraries and frameworks, we would like to thank all the contributors for their work. Here is a list of the main libraries and frameworks we use:
+
+- [Pytorch](https://pytorch.org/) and [Pytorch Lightning](https://lightning.ai/) for training and deploying deep learning models. These two libraries are core part of training and testing tasks that allow us to run experiments on different devices in agile way.
+- Pretrained models are usually loaded from [Pytorch Hub](https://pytorch.org/hub/) or [Pytorch-image-models](https://github.com/huggingface/pytorch-image-models) (or called as `timm`).
+- Each specific task may rely on different libraries. For example, `segmentation` task uses [Segmentation_models.pytorch](https://github.com/qubvel/segmentation_models.pytorch) for loading backbones. The `anomaly detection` task uses a fork of [Anomalib](https://github.com/openvinotoolkit/anomalib) maintained by Orobix on [this repository](https://github.com/orobix/anomalib). We use light-weight ML models from [scikit-learn](https://scikit-learn.org/). We have also implementation of some SOTA models inside our library. 
+- Data processing and augmentation are done using [Albumentations](https://albumentations.ai/docs/) and [OpenCV](https://opencv.org/).
+- [Hydra](https://hydra.cc/docs/intro/) for composing configurations and running experiments. Hydra is a powerful framework that allows us to compose configurations from command line interface and run multiple experiments with different settings and hyperparameters. We have followed suggestions from `Configuring Experiments` section of [Hydra documentation](https://hydra.cc/docs/patterns/configuring_experiments/) and [lightning-hydra-template](https://github.com/ashleve/lightning-hydra-template) repository.
+- Documentation website is using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) and [MkDocs](https://www.mkdocs.org/). For code documentation we are using [Mkdocstrings](https://mkdocstrings.github.io/). For releasing software versions we combine [Bumpver](https://github.com/mbarkhau/bumpver) and [Mike](https://github.com/jimporter/mike).
+- Models can be exported in different ways (`torchscript` or `torch` file). We have also added [ONNX](https://onnx.ai/) support for some models.
+- Testing framework is based on [Pytest](https://docs.pytest.org/en/) and related plug-ins.
+- Code quality is ensured by [pre-commit](https://pre-commit.com/) hooks. We are using [Ruff](https://github.com/astral-sh/ruff) for linting, enforcing code quality and formatting, [Pylint](https://www.pylint.org/) for in depth linting and [Mypy](https://mypy.readthedocs.io/en/stable/) for type checking.
+
+## FAQ
+
+**How can I fix errors related to `GL` when I install full `opencv` package?**
+
+If you are running on a remote server without a display and you are using `opencv-python` instead of `opencv-python-headless` you can run the following command to fix the issue:
+
+It can be solved by correctly linking the `libGL.so.1` library:
+
+```bash
+# Check where the library is located
+find /usr -name libGL.so.1
+```
+
+```bash
+# if the library is located in /usr/lib/x86_64-linux-gnu
+# link it to /usr/lib
+sudo ln -s /usr/lib/x86_64-linux-gnu/libGL.so.1 /usr/lib/libGL.so
+```
+
+or installing following packages (depending on your OS this may vary):
+
+```bash
+sudo apt-get install libgl1-mesa-glx
+```
+
+
+**How can I run multiple experiments with single command?**
+
+You can run multiple experiments with a single command by passing `--multirun` flag:
+
+```bash
+quadra <configurations> --multirun
+```
+
+For example if you want to run same experiment with different seeds you can run:
+
+```bash
+quadra experiment=generic/imagenette/classification/default trainer=lightning_cpu logger=csv core.seed=1,2,3 --multirun 
+```
+
+