Quickstart

Releases

eIQ AI Toolkit is made up of multiple Docker images. As such, we provide a docker-compose.yaml for simplicity to install all the images. We suggest to use the latest release unless there are compatibility reasons.

Prerequisites

Linux environment

Since the eIQ AI Toolkit is fully containerized, you need to have Docker installed. For a simpler setup, we also recommend using Docker Compose.

Windows environment

Windows is not directly supported; however, you can use Windows Subsystem for Linux 2 (WSL 2) or a similar virtual environment and then follow the Linux installation instructions.

Note

Docker & Docker Compose utilities can be installed in WSL 2 or Linux as described in the official Docker documentation or here for Docker Compose.

Launch

  1. Download the premade eIQ AI Toolkit docker-compose.yaml file.

  2. Open a terminal window in the same directory as the docker-compose.yaml file.

  3. Run the following command which downloads the relevant images from NXP Docker repository and starts all the required containers:

docker compose up

or for the Docker containers to run in the background:

docker compose up --detach

  1. Now open a web browser of your choice and just input the following URL to access the graphical interface:

localhost:8080

or the following URL to access the REST API via Swagger UI:

localhost:8000/docs

Cleanup

For stopping the eIQ AI Toolkit containers, use the following command:

docker compose stop

If your aim is to stop as well as delete the eIQ AI Toolkit containers, type the following in the terminal:

docker compose down

To get rid of the eIQ AI Toolkit containers and also delete the content of the mounted volumes (reset data) to start fresh:

docker compose down -v

Cleanup and Update

If you previously used eIQ AI Toolkit, you may need to update your images:

docker-compose pull
docker-compose up --force-recreate --build -d
docker image prune -f

or remove unused ones:

sudo docker rm -f $(sudo docker ps -a -q)
docker container prune