Quickstart

Releases

eIQ AI Toolkit consists of multiple Docker images. To simplify installation and deployment, we provide a consolidated docker-compose.yaml that pulls and configures all required images. Unless there are specific compatibility constraints, we recommend using the latest available release.

Prerequisites

eIQ AI Toolkit is provided as a fully containerized environment and therefore requires Docker to be installed. For easier setup and management, the use of Docker Compose is also recommended.

Supported Platforms

  • Linux is the recommended and fully supported platform.

  • Windows is not natively supported; however, users may run the software using Windows Subsystem for Linux 2 (WSL 2) or a comparable virtualized Linux environment and follow the Linux installation instructions.

  • macOS is not currently tested and therefore is not officially supported.

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 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

Note

Database Migrations

When you start eIQ AI Toolkit using the docker compose up command, the application automatically checks for any pending database migrations and applies them on startup. If your database already contains data, eIQ AI Toolkit will safely update the schema to the latest version without requiring any manual intervention. This ensures your database structure stays in sync with the application at all times.

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