ns-viewer

Load a checkpoint and start the viewer.

usage: ns-viewer [-h] --load-config PATH [--viewer.relative-log-filename STR]
                 [--viewer.websocket-port {None}|INT]
                 [--viewer.websocket-port-default INT]
                 [--viewer.websocket-host STR]
                 [--viewer.max-num-display-images INT]
                 [--viewer.quit-on-train-completion {True,False}]
                 [--viewer.image-format {jpeg,png}]
                 [--viewer.jpeg-quality INT]
                 [--viewer.make-share-url {True,False}]
                 [--vis {viewer,viewer_beta}] [--make-share-url {True,False}]

arguments

--load-config

Path to config YAML file. (required)

--vis

Possible choices: viewer_beta, viewer

Type of viewer (default: viewer)

--make-share-url

Possible choices: True, False

Viewer beta feature: print a shareable URL. vis must be set to viewer_beta; this flag is otherwise ignored. (default: False)

viewer arguments

Viewer configuration

--viewer.relative-log-filename

Filename to use for the log file. (default: viewer_log_filename.txt)

--viewer.websocket-port

The websocket port to connect to. If None, find an available port. (default: None)

--viewer.websocket-port-default

The default websocket port to connect to if websocket_port is not specified (default: 7007)

--viewer.websocket-host

The host address to bind the websocket server to. (default: 0.0.0.0)

--viewer.max-num-display-images

Maximum number of training images to display in the viewer, to avoid lag. This does not change which images are actually used in training/evaluation. If -1, display all. (default: 512)

--viewer.quit-on-train-completion

Possible choices: True, False

Whether to kill the training job when it has completed. Note this will stop rendering in the viewer. (default: False)

--viewer.image-format

Possible choices: png, jpeg

Image format viewer should use; jpeg is lossy compression, while png is lossless. (default: jpeg)

--viewer.jpeg-quality

Quality tradeoff to use for jpeg compression. (default: 90)

--viewer.make-share-url

Possible choices: True, False

Viewer beta feature: print a shareable URL. vis must be set to viewer_beta; this flag is otherwise ignored. (default: False)