degirum/aiclient repository overview

⁠About This Repo

This is the Git repo of the official Docker image for DeGirum AI Client.

The image is based on python:3.10-slim⁠ image and contains DeGirum PySDK⁠ and JupyterLab⁠ packages. All additional Python packages to be installed at the image creation process are listed in requirements.txt⁠.

Once the Docker container is started, JupyterLab accepts client connections on port 8888. JUPYTER_TOKEN environment variable is used to define JupyterLab token value. /degirum directory inside the container serves as JupyterLab root directory and contains DeGirum PySDK examples⁠.

⁠How to Build and Use Official AI Client Docker Image

Pre-requisites: Docker Desktop⁠ or Docker Engine⁠ is installed on the docker host: the computer where you want to build or run the docker container.

DeGirum provides pre-built Docker container image on DockerHub⁠, so you can run it right away.

To run the Docker container (either the one you built yourself (see below) or the one from DockerHub), execute the following command:

docker run -it --rm -p 8080:8888 -v /my/work/dir:/degirum -e JUPYTER_TOKEN="token" degirum/aiclient:latest

Here you specify /my/work/dir and "token" parameters, described just below.

You can open http://docker_host_IP:8080 URL in your browser to access JupyterLab (here docker_host_IP is the IP address or the host name of the docker host computer).

The "token" parameter serves as your login credentials to JupyterLab.

The /my/work/dir parameter is the docker host computer local directory, which is used as a JupyterLab root directory.

If you want to build the Docker container image yourself instead, execute the following commands:

git clone https://github.com/DeGirum/docker-degirum
cd docker-degirum/aiclient
docker build . -t degirum/aiclient:latest