CLI#

The PSSR2 CLI is included with package installation. It provides a simple interface for using PSSR2 without having to write any code, and covers most basic use cases.

PSSR2 CLI for basic usage

usage: pssr [-h] [-t] [-dp DATA_PATH] [-dt DATA_TYPE] [-mt MODEL_TYPE]
            [-mp MODEL_PATH] [-e EPOCHS] [-b BATCH_SIZE] [-lr LR]
            [-p PATIENCE] [-mse] [-cp] [-sl]

Named Arguments#

-t, --train

enable train mode

Default: False

-dp, --data-path

specify dataset path

-dt, --data-type

specify dataset type

Default: “ImageDataset”

-mt, --model-type

specify model type

Default: “ResUNet”

-mp, --model-path

specify model path

-e, --epochs

specify number of training epochs

Default: 10

-b, --batch-size

specify batch size

Default: 16

-lr, --lr

specify learning rate

Default: 0.001

-p, --patience

specify learning rate decay patience

Default: 3

-mse, --mse

use MSE loss instead of MS-SSIM loss

Default: False

-cp, --checkpoint

save model checkpoints during training

Default: False

-sl, --save-losses

save training losses

Default: False