From e14c58f748364143b34e870a0edcd0f45c7baf95 Mon Sep 17 00:00:00 2001 From: Martin Kozlovsky Date: Tue, 9 Jul 2024 19:45:46 +0200 Subject: [PATCH] updated readme --- README.md | 28 +++++++++++++++++----------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 3f85bc4..108d415 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,8 @@ Convert your **ONNX** models to a format compatible with any generation of Luxon - [MLOps - Compilation Library](#mlops---compilation-library) - [Table of Contents](#table-of-contents) - [Installation](#installation) + - [Before You Begin](#before-you-begin) + - [Instructions](#instructions) - [GPU Support](#gpu-support) - [Running ModelConverter](#running-modelconverter) - [Sharing Files](#sharing-files) @@ -38,6 +40,13 @@ Convert your **ONNX** models to a format compatible with any generation of Luxon ## Installation +### System Requirements + +`ModelConverter` requires `docker` to be installed on your system. +It is recommended to use Ubuntu OS for the best compatibility. +On Windows or MacOS, it is recommended to install `docker` using the [Docker Desktop](https://www.docker.com/products/docker-desktop). +Otherwise follow the installation instructions for your OS from the [official website](https://docs.docker.com/engine/install/). + ### Before You Begin `ModelConverter` is in an experimental public beta stage. Some parts might change in the future. @@ -57,24 +66,21 @@ Requires `snpe.zip` archive to be present in `docker/extra_packages`. You can do 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 +### Instructions + +1. Build the docker image: -1. Ensure `docker` is installed on your machine. If not, refer to the installation guide [here](https://docs.docker.com/engine/install/). + ```bash + docker build -f docker//Dockerfile.public -t luxonis/modelconverter-:latest . + ``` -1. Install the modelconverter package. You can install it from PyPI using the following command: +1. For easier use, you can install the ModelConverter CLI. You can install it from PyPI using the following command: ```bash pip install modelconv ``` - -1. Build the docker image: - -```bash -docker build -f docker//Dockerfile.public -t luxonis/modelconverter-:latest . -``` - -This will also install the `modelconverter` CLI. For usage instructions, see `modelconverter --help`. + For usage instructions, see `modelconverter --help`. ### GPU Support