gui package

gui.gui_server module

gui.gui_server.run_server(host='127.0.0.1', port=8080, api_host='localhost', api_port=5000)

Initializes a server that serves the GUI and connects to a running instance of cortex.api

Parameters

• host – The host on which the GUI should run

• port – The port on which the GUI should run

• api_host – The address of a running instance of cortex.api

• api_port – The port of a running instance of cortex.api

Module contents

cortex.gui is a submodule that is responsible for serving the GUI of Cortex. If you want to run the GUI in development mode, go to the cortex/gui/cortex-gui directory and run ‘npm run serve’

CLI

python -m cortex.gui

The GUI CLI

python -m cortex.gui [OPTIONS] COMMAND [ARGS]...

run-server

Starts a server that server the GUI

python -m cortex.gui run-server [OPTIONS]

Options

-h, --host <host>

The host of the GUI server

-p, --port <port>

The port of the GUI server

-H, --api-host <api_host>

The host of a running instance of cortex.api

-P, --api-port <api_port>

The port of a running instance of cortex.api