modelconv 0.1.1__tar.gz

modelconv-0.1.1/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 [yyyy] [name of copyright owner]
+
+   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.

modelconv-0.1.1/PKG-INFO

@@ -0,0 +1,357 @@
+Metadata-Version: 2.1
+Name: modelconv
+Version: 0.1.1
+Summary: Converter for neural models into various formats.
+Author-email: Luxonis <support@luxonis.com>
+Maintainer-email: Luxonis <support@luxonis.com>
+Project-URL: repository, https://github.com/luxonis/modelconverter
+Project-URL: issues, https://github.com/luxonis/modelconverter/issues
+Keywords: ml,onnx,openvino,nn,ai,embedded
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Image Processing
+Classifier: Topic :: Scientific/Engineering :: Image Recognition
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Pillow
+Requires-Dist: PyYAML
+Requires-Dist: gcsfs
+Requires-Dist: luxonis-ml[data,nn_archive]>=0.2.2
+Requires-Dist: onnx
+Requires-Dist: onnxruntime
+Requires-Dist: onnxsim
+Requires-Dist: s3fs
+Requires-Dist: s3transfer
+Requires-Dist: typer
+Requires-Dist: docker
+Provides-Extra: bench
+Requires-Dist: depthai; extra == "bench"
+Requires-Dist: pandas; extra == "bench"
+Provides-Extra: dev
+Requires-Dist: pre-commit==3.2.1; extra == "dev"
+Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
+Requires-Dist: docker-squash>=1.1.0; extra == "dev"
+Requires-Dist: depthai; extra == "dev"
+Requires-Dist: pandas; extra == "dev"
+
+# ModelConverter - Compilation Library
+
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![PyPI](https://img.shields.io/pypi/v/luxonis-ml?label=pypi%20package)](https://pypi.org/project/modelconverter/)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/luxonis-ml)](https://pypi.org/project/modelconverter/)
+
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Docformatter](https://img.shields.io/badge/%20formatter-docformatter-fedcba.svg)](https://github.com/PyCQA/docformatter)
+[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+Convert your **ONNX** models to a format compatible with any generation of Luxonis camera using the **Model Compilation Library**.
+
+## Status
+
+| Package   | Test                                                                                                  | Deploy                                                                                                  |
+| --------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
+| **RVC2**  | ![RVC2 Tests](https://github.com/luxonis/modelconverter/actions/workflows/rvc2_test.yaml/badge.svg)   | ![RVC2 Push](https://github.com/luxonis/modelconverter/actions/workflows/rvc2_publish.yaml/badge.svg)   |
+| **RVC3**  | ![RVC3 Tests](https://github.com/luxonis/modelconverter/actions/workflows/rvc3_test.yaml/badge.svg)   | ![RVC3 Push](https://github.com/luxonis/modelconverter/actions/workflows/rvc3_publish.yaml/badge.svg)   |
+| **RVC4**  | ![RVC4 Tests](https://github.com/luxonis/modelconverter/actions/workflows/rvc4_test.yaml/badge.svg)   | ![RVC4 Push](https://github.com/luxonis/modelconverter/actions/workflows/rvc4_publish.yaml/badge.svg)   |
+| **Hailo** | ![Hailo Tests](https://github.com/luxonis/modelconverter/actions/workflows/hailo_test.yaml/badge.svg) | ![Hailo Push](https://github.com/luxonis/modelconverter/actions/workflows/hailo_publish.yaml/badge.svg) |
+
+## Table of Contents
+
+- [MLOps - Compilation Library](#mlops---compilation-library)
+  - [Table of Contents](#table-of-contents)
+  - [Installation](#installation)
+    - [GPU Support](#gpu-support)
+  - [Running ModelConverter](#running-modelconverter)
+    - [Sharing Files](#sharing-files)
+    - [Usage](#usage)
+    - [Examples](#examples)
+  - [Multi-Stage Conversion](#multi-stage-conversion)
+  - [Interactive Mode](#interactive-mode)
+  - [Calibration Data](#calibration-data)
+  - [Inference](#inference)
+    - [Inference Example](#inference-example)
+  - [Benchmarking](#benchmarking)
+
+## Installation
+
+### Before You Begin
+
+`ModelConverter` is in an experimental public beta stage. Some parts might change in the future.
+
+To build the images, you need to download additional packages depending on the selected target.
+
+**RVC2 and RVC3**
+
+Requires `openvino_2022_3_vpux_drop_patched.tar.gz` to be present in `docker/extra_packages`.
+You can download the archive [here](https://drive.google.com/file/d/1IXtYi1Mwpsg3pr5cDXlEHdSUZlwJRTVP/view?usp=share_link).
+
+**RVC4**
+
+Requires `snpe.zip` archive to be present in `docker/extra_packages`. You can download an archive with the current version [here](https://softwarecenter.qualcomm.com/api/download/software/qualcomm_neural_processing_sdk/v2.23.0.24.06.24.zip). You only need to rename it to `snpe.zip` and place it in the `docker/extra_packages` directory.
+
+**HAILO**
+
+Requires `hailo_ai_sw_suite_2024-04:1` docker image to be present on the system. You can download the image from the [Hailo website](https://developer.hailo.ai/developer-zone/sw-downloads/).
+
+### Building the Image
+
+1. Ensure `docker` is installed on your machine. If not, refer to the installation guide [here](https://docs.docker.com/engine/install/).
+
+1. Install the modelconverter package. You can install it from PyPI using the following command:
+
+   ```bash
+   pip install modelconv
+
+   ```
+
+1. Build the docker image:
+
+```bash
+docker build -f docker/<package>/Dockerfile.public -t luxonis/modelconverter-<package>:latest .
+```
+
+This will also install the `modelconverter` CLI. For usage instructions, see `modelconverter --help`.
+
+### GPU Support
+
+To enable GPU acceleration for `hailo` conversion, install the [Nvidia Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html#docker).
+
+## Running ModelConverter
+
+Configuration for the conversion predominantly relies on a `yaml` config file. For reference, see [defaults.yaml](shared_with_container/configs/defaults.yaml) and other examples located in the [shared_with_container/configs](shared_with_container/configs) directory.
+
+However, you have the flexibility to modify specific settings without altering the config file itself. This is done using command line arguments. You provide the arguments in the form of `key value` pairs. For better understanding, see [Examples](#examples).
+
+### Sharing Files
+
+When using the supplied `docker-compose.yaml`, the `shared_with_container` directory facilitates file sharing between the host and container. This directory is mounted as `/app/shared_with_container/` inside the container. You can place your models, calibration data, and config files here. The directory structure is:
+
+```txt
+shared_with_container/
+│
+├── calibration_data/
+│ └── <calibration data will be downloaded here>
+│
+├── configs/
+│ ├── resnet18.yaml
+│ └── <configs will be downloaded here>
+│
+├── models/
+│ ├── resnet18.onnx
+│ └── <models will be downloaded here>
+│
+└── outputs/
+  └── <output_dir_name>
+    ├── resnet18.onnx
+    ├── resnet18.dlc
+    ├── logs.txt
+    ├── config.yaml
+    └── intermediate_outputs/
+      └── <intermediate files generated during the conversion>
+```
+
+While adhering to this structure is not mandatory as long as the files are visible inside the container, it is advised to keep the files organized.
+
+The converter first searches for files exactly at the provided path. If not found, it searches relative to `/app/shared_with_container/`.
+
+The `output_dir_name` can be specified in the config file. If such a directory already exists, the `output_dir_name` will be appended with the current date and time. If not specified, the `output_dir_name` will be autogenerated in the following format: `<model_name>_to_<target>_<date>_<time>`.
+
+### Usage
+
+You can run the built image either manually using the `docker run` command or using the `modelconverter` CLI.
+
+1. Set your credentials as environment variables (if required):
+
+   ```bash
+   export AWS_SECRET_ACCESS_KEY=<your_aws_secret_access_key>
+   export AWS_ACCESS_KEY_ID=<your_aws_access_key_id>
+   export AWS_S3_ENDPOINT_URL=<your_aws_s3_endpoint_url>
+   ```
+
+1. If `shared_with_container` directory doesn't exist on your host, create it.
+
+1. Without remote files, place the model, config, and calibration data in the respective directories (refer [Sharing Files](#sharing-files)).
+
+1. Execute the conversion:
+
+- If using the `docker run` command:
+  ```bash
+  docker run --rm -it \
+    -v $(pwd)/shared_with_container:/app/shared_with_container/ \
+    -e AWS_SECRET_ACCESS_KEY=$AWS_SECRET_ACCESS_KEY \
+    -e AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID \
+    -e AWS_S3_ENDPOINT_URL=$AWS_S3_ENDPOINT_URL \
+    luxonis/modelconverter-<package>:latest \
+    convert <target> \
+    --path <s3_url_or_path> [ config overrides ]
+  ```
+- If using the `modelconverter` CLI:
+  ```bash
+  modelconverter convert <target> --path <s3_url_or_path> [ config overrides ]
+  ```
+- If using `docker-compose`:
+  ```bash
+  docker compose run <target> convert <target> ...
+  ```
+
+### Examples
+
+Use `resnet18.yaml` config, but override `calibration.path`:
+
+```bash
+modelconverter convert rvc4 --path configs/resnet18.yaml \
+                        calibration.path s3://path/to/calibration_data
+```
+
+Override inputs and outputs with command line arguments:
+
+```bash
+modelconverter convert rvc3 --path configs/resnet18.yaml \
+                        inputs.0.name input_1 \
+                        inputs.0.shape "[1,3,256,256]" \
+                        outputs.0.name output_0
+```
+
+Specify all options via the command line without a config file:
+
+```bash
+modelconverter convert rvc2 input_model models/yolov6n.onnx \
+                        scale_values "[255,255,255]" \
+                        reverse_input_channels True \
+                        shape "[1,3,256,256]" \
+                        outputs.0.name out_0 \
+                        outputs.1.name out_1 \
+                        outputs.2.name out_2
+```
+
+## Multi-Stage Conversion
+
+The converter supports multi-stage conversion. This means conversion of multiple
+models where the output of one model is the input to another model. For mulit-stage
+conversion you must specify the `stages` section in the config file, see [defaults.yaml](shared_with_container/configs/defaults.yaml)
+and [multistage.yaml](shared_with_container/configs/multistage.yaml) for reference.
+
+The output directory structure would be (assuming RVC4 conversion):
+
+```txt
+output_path/
+├── config.yaml
+├── modelconverter.log
+├── stage_name1
+│   ├── config.yaml
+│   ├── intermediate_outputs/
+│   ├── model1.onnx
+│   └── model1.dlc
+└── stage_name2
+    ├── config.yaml
+    ├── intermediate_outputs/
+    ├── model2.onnx
+    └── model2.dlc
+```
+
+## Interactive Mode
+
+Run the container interactively without any post-target arguments:
+
+```bash
+modelconverter shell rvc4
+```
+
+Inside, you'll find all the necessary tools for manual conversion.
+The `modelconverter` CLI is available inside the container as well.
+
+## Calibration Data
+
+Calibration data can be a mix of images (`.jpg`, `.png`, `.jpeg`) and `.npy`, `.raw` files.
+Image files will be loaded and converted to the format specified in the config.
+No conversion is performed for `.npy` or `.raw` files, the files are used as provided.
+**NOTE for RVC4**: `RVC4` expects images to be provided in `NHWC` layout. If you provide the calibration data in a form of `.npy` or `.raw` format, you need to make sure they have the correct layout.
+
+## Inference
+
+A basic support for inference. To run the inference, use `modelconverter infer <target> <args>`.
+For usage instructions, see `modelconverter infer --help`.
+
+The input files must be provided in a specific directory structure.
+
+```txt
+input_path/
+├── <name of first input node>
+│   ├── 0.npy
+│   ├── 1.npy
+│   └── ...
+├── <name of second input node>
+│   ├── 0.npy
+│   ├── 1.npy
+│   └── ...
+├── ...
+└── <name of last input node>
+    ├── 0.npy
+    ├── 1.npy
+    └── ...
+```
+
+**Note**: The numpy files are sent to the model with no preprocessing, so they must be provided in the correct format and shape.
+
+The output files are then saved in a similar structure.
+
+### Inference Example
+
+For `yolov6n` model, the input directory structure would be:
+
+```txt
+input_path/
+└── images
+    ├── 0.npy
+    ├── 1.npy
+    └── ...
+```
+
+To run the inference, use:
+
+```bash
+modelconverter infer rvc4 \
+  --model_path <path_to_model.dlc> \
+  --dest <dest> \
+  --input_path <input_path>
+  --path <path_to_config.yaml>
+```
+
+The output directory structure would be:
+
+```txt
+output_path/
+├── output1_yolov6r2
+│   ├── 0.npy
+│   ├── 1.npy
+│   └── ...
+├── output2_yolov6r2
+│   └── <outputs>
+└── output3_yolov6r2
+    └── <outputs>
+```
+
+## Benchmarking
+
+The ModelConverter additionally supports benchmarking of converted models.
+
+To install the package with the benchmarking dependencies, use:
+
+```bash
+pip install modelconv[bench]
+```
+
+To run the benchmark, use `modelconverter benchmark <target> <args>`.
+
+For usage instructions, see `modelconverter benchmark --help`.
+
+**Example:**
+
+```bash
+modelconverter benchmark rvc3 --model-path <path_to_model.xml>
+```
+
+The command prints a table with the benchmark results to the console and
+optionally saves the results to a `.csv` file.