Installation

Requirements

To install Giskard, you need
Run the following commands to install Giskard in your server
1
git clone https://github.com/Giskard-AI/giskard.git
2
cd giskard
3
docker-compose up -d --force-recreate
Copied!
once the docker-compose starts all of the modules you'll be able to open Giskard at
The default credentials are
Login: admin
Password: admin
You're all set to try Giskard in action, upload your first model by following the Upload your model tutorial.

Upgrade Giskard to the latest version

In order to upgrade Giskard to the latest version, please run the following in your Giskard distribution directory
1
git pull
2
docker-compose down && docker-compose pull && docker-compose up -d --force-recreate
Copied!

Install additional Python libraries

If you need specific Python libraries that are not pre-installed in Giskard and that are available in PyPI, git, locally etc., you can install them manually in Giskard. To do so, execute the following commands:
  1. 1.
    Go to giskard/giskard-ml-worker/ml-worker.dockerfile
  2. 2.
    Below the line RUN bash -c "if [ $INSTALL_DEV == 'true' ] , write the following line:
1
RUN poetry add <YOUR LIBRARY> #With Poetry you can add libraries hosted locally, Github, PyPI, etc. See: https://python-poetry.org/docs/cli/#add etc
Copied!
3. From the root of the Giskard directory run
1
docker-compose stop ml-worker
2
docker-compose -f docker-compose.dev.yml -f docker-compose.yml build ml-worker
3
docker-compose up ml-worker
Copied!

Install a new Python version

Giskard application is working on Python 3.7, if you use another Python version (3.9 or 3.10 for instance), please follow these steps:
  1. 1.
    Change Python version in giskard/giskard-ml-worker/ml-worker.dockerfile
  2. 2.
    Run the following command lines
1
docker-compose -f docker-compose.dev.yml -f docker-compose.yml build ml-worker
2
docker-compose down ml-worker && docker-compose up ml-worker
Copied!