Configuration
How to configure your Giskard application: Email notifications and API tokens
To compute local explanations of textual features, Giskard uses the LIME algorithm. LIME creates
n_samples of distorted texts to compute the explanation. When n_samples is high, the provided explanation is better, but the computation time will be higher as well.By default, n_samples is equal to 500. To change it, you need to change the project settings. To do that, click on Edit in the top right corner of your screen (see the image below)
Giskard can send email notifications about different events like inspector feedbacks or user invitation to the platform.
To configure this feature SMTP server credentials should be provided at startup through environment variables
Environment variable name | Purpose |
|---|---|
GISKARD_MAIL_HOST | SMTP server address |
GISKARD_MAIL_PORT | SMTP port, 587 by default |
GISKARD_MAIL_USERNAME | |
GISKARD_MAIL_PASSWORD | |
GISKARD_MAIL_BASEURL | Publicly available Giskard instance URL |
Giskard authentication is based on JWT tokens. These tokens are issued by Giskard backend based on a JWT secret key.
To reinforce security there's no default value of the secret key, whenever the backend starts it generates one automatically. However it means that users' sessions are invalidated and they have to re-login.
For production instances, it's preferred to keep user sessions alive no matter whether the server was rebooted or not. In this case, the JWT secret can be set from the outside by specifying
GISKARD_JWT_SECRET environment variable. Its value should contain a base64 encoded bytes sequence of at least 128 bytes.The following script can generate and store a secret key of 256 bytes:
# for zsh
echo export GISKARD_JWT_SECRET=`openssl rand -base64 256 | tr -d '\n'` >> ~/.zshrc
# for bash
echo export GISKARD_JWT_SECRET=`openssl rand -base64 256 | tr -d '\n'` >> ~/.bashrc
Last modified 10d ago