LizGoban is an analysis tool of the game Go with Leela Zero and KataGo. It is an implementation of Lizzie-style real-time UI on Electron.
- Leela Zero does not tell the reason of suggestions. So LizGoban aims at a GUI for easy trial of what-if in addition to quick browse of proposed variations. For example, you can use any number of trial boards in parallel, discard a needless one by a single action, and restore the deleted one if necessary.
- Though Lizzie is amazingly useful, its setup is not easy for many Go players because it needs Java. In this project, the core feature of Lizzie is transported to JavaScript so that they can taste the joy of real-time analysis.
- Flexibility of JavaScript also enables quick experiments of fun features, e.g. watching Leela Zero vs. ELF with real-time detection of the difference between their plans before they play the move actually.
- Leela Zero's suggestions are not 100% reliable, of course. We hope to get some signs when the suggested moves are unreliable. LizGoban visualizes convergence and consistency of estimations for this purpose. We can notice the case when we should wait for a little more analysis, and will never miss a new rising candidate like the one in the above screenshot.
- Additionally, various small ideas are implemented, e.g. translucent stones for too long variations, different colors for good/bad/unexpected moves in the win-rate graph, etc.
Like Lizzie...
- Colored suggestions / Variation by mouse hover
- Subboard that always shows the principal variation
- Clickable & draggable win-rate graph with autoanalysis
- Multiple engines that can be switched quickly
- Open URL (by drag & drop or clipboard)
And more...
- Visualization of search progress via plots of visits, winrate, score, prior, ...
- Real-time display of area counts by KataGo
- Trial boards that can be used like tabs in web browsers
- Detection of inconsistency between analyses before/after a move
- Watch Leela Zero vs. KataGo etc. with real-time comparison of their plans
- Play against weakened engines in several ways
- Keyboard shortcuts, e.g. "3" key for the third variation
- Analysis of gains and losses in recent moves by KataGo that reveals overlooked side effects
- Indicators that suggest highlight scenes of the game (big kills, ko fights, etc.)
- Let-me-think-first mode in autoplay: plain board for n seconds and then suggestions for n seconds in each move
- Personal exercise book that can be used like bookmarks in web browsers for random exercise
Just download the all-in-one package. You can use it immediately without installation, configuration, additional downloads, etc.
BadukMegapack by wonsiks may be the easiest way to install LizGoban together with many other tools. (Though it is not tested by the author of LizGoban, who does not have a Windows machine.)
Otherwise, see the release note to replace the built-in engines with GPU versions in Case I or follow the steps in Case III.
- Install Node.js.
- Type
git clone https://github.com/kaorahi/lizgoban; cd lizgoban; npm installon a terminal. - Put Leela Zero binary (version 0.17 or later) as
external/leelaztogether with its network weight asexternal/network.gz. - Type
npm start. (Windows: Double-clicklizgoban_windows.vbs.)
Use npm start -- --no-sandbox if you get an error like "The SUID sandbox helper binary was found, but is not configured correctly" and you do not want to fix it.
Start it as
npm start -- -c config.json
with the file config.json:
{"sgf_dir": "/foo/bar/sgf/"}
(Windows: Put the above config.json into the same folder as lizgoban_windows.vbs and double-click lizgoban_windows.vbs.)
Here is a more practical example of config.json:
{
"analyze_interval_centisec": 20,
"sgf_dir": "/foo/bar/sgf/",
"exercise_dir": "/foo/bar/exercise/",
"max_cached_engines": 3,
"preset": [
{
"label": "Leela Zero",
"accelerator": "F1",
"engine": ["/foo/bar/leelaz", "-g", "-w", "/foo/lz_net/254.gz"]
},
{
"label": "KataGo",
"accelerator": "F2",
"engine": ["/foo/bar/katago", "gtp",
"-model", "/foo/kata_net/g104-b20c256.gz",
"-config", "/foo/bar/gtp.cfg"]
},
{
"label": "Aggressive",
"engine": ["/foo/bar/katago", "gtp",
"-model", "/foo/kata_net/g104-b20c256.gz",
"-config", "/foo/bar/gtp_aggressive.cfg"]
},
{
"label": "LZ vs. KATA",
"empty_board": true,
"engine": ["/foo/bar/leelaz", "-g", "-w", "/foo/lz_net/254.gz"],
"engine_for_white": ["/foo/bar/katago", "gtp",
"-model", "/foo/kata_net/g104-b20c256.gz",
"-config", "/foo/bar/gtp.cfg"]
},
{"label": "Hide hints", "accelerator": "F3", "board_type": "raw"},
{"label": "Show hints", "accelerator": "F4", "board_type": "double_boards"}
]
}
- analyze_interval_centisec: Update interval of analysis display (1 = 0.01sec).
- sgf_dir: Default directory for [Open SGF] and [Save SGF] menus. (*1)
- exercise_dir: Directory for your personal exercise book. (*1)
- max_cached_engines: Maximum number of simultaneous engine processes. You can set this as 5 for quicker switch of 5 different engines / weights, for example, if your machine has enough spec.
- preset: You can switch the given settings by [Preset] menu in LizGoban. The first one is used as default.
- label: Item name shown in [Preset] menu.
- accelerator: Shortcut key like "Shift+F3", "CmdOrCtrl+F4", "Alt+F5", etc. It can be omitted as the above "LZ vs. KATA".
- engine: Engine command. (*1)
- engine_for_white: Alternative engine is used for white if this is set. (*1)
- empty_board: Set it true for creating new empty board.
- board_type: One of "double_boards", "double_boards_raw", "double_boards_swap", "double_boards_raw_pv", "raw", "suggest", "variation", "winrate_only". See [View] menu for their appearances.
(*1) In these items, you can use relative paths from the "working directory", that is the folder of LizGoban*.exe itself in the all-in-one package or external/ otherwise. For example, you can simply write "leelaz" for external/leelaz.
It is recommended to put all Leela Zero weights into one directory and all KataGo weights into another directory for using [Load network weights] menu conveniently. Delete obsolete "weight_dir" in your config.json if you wrote it.
For quick experiments, you can also use
npm start -- -j '{"sgf_dir": "/foo/bar/baz/"}'
npm start -- -c config.json -j '{"sgf_dir": "/foo/bar/baz/"}'
etc.
on Mac or Linux. The latter option overwrites the former one in the second example.
In addition, LizGoban reads external/config.json (and config.json in the "working directory" in the above (*1)) beforehand if they exist.
Set KataGo like the above config.json and select it in [Preset] menu. See "KataGo" section in [Help] menu for details.
For high handicap games, you have to prepare another gtp.cfg because LizGoban cannot use KataGo's dynamical adjusting of aggressiveness at present. This is an example of gtp_aggressive.cfg for KataGo v1.3.1.
...
# dynamicPlayoutDoublingAdvantageCapPerOppLead = 0.04
...
playoutDoublingAdvantage = 2.0
...
This is based on endstate_head branch by ihavnoid.
- Build a modified leelaz and rename "leelaz" to "leelaz_endstate".
- Download the weight file and rename it to "network_endstate.gz".
- Start LizGoban as
npm start -- -c config.jsonwith the file config.json:
{
"endstate_leelaz": ["/foo/bar/leelaz_endstate",
["-g", "-w", "/foo/bar/network_endstate.gz"]],
...
}
(Sorry for the ugly second brackets [] for backward compatibility.)
It is ignored when you are using KataGo, that gives more reliable estimations.
To attach LizGoban to Sabaki as subwindows (obsolete, may be deleted in future):
- Build a customized Sabaki in "dump_state2" branch.
- Put Sabaki binary as "external/sabaki".
- Start LizGoban.
- Click "Attach Sabaki" in "Tool" menu of LizGoban and wait for Sabaki window.
- Put a stone on Sabaki and see it appears on LizGoban.
- Support 9x9 and 13x13 in "File" menu.
- Add "Rule" into "Edit" menu for KataGo v1.3.
- Add indicators that suggest highlight scenes of the game (big kills, ko fights, etc.).
- Separate estimations by different engines in winrate graph.
- Show start-up log when engine is down.
- Fix blur in HiDPI display.
Incompatibilities:
- Upgrade libraries (Electron 7, etc.). So you may need to do "npm install" again.
- "weight_dir" in config.json is obsolete now. (See above.)
- "Komi" and "Info" are moved from [Tool] to [Edit] menu.
- Open URL by drag & drop or clipboard.
- Count stones separately in area counts. (See "KataGo" section in "Help" menu.)
- Flip & rotate the board randomly in exercise.
- Add "preset" to switch engines inside LizGoban.
- Add "max_cached_engines" for quicker switch of engines / weights.
- Enable autoplay between different engines.
- Add "personal exercise book".
- Improve komi features.
- The format of config.json is modified. (The obsolete format also works at present.)
- Some items are moved to [Engine] menu.
- The all-in-one package (*.exe) is offered for Windows.
- The launcher command is changed from "npx electron src" to "npm start".
- "Load engine" menu is deleted because it is misleading.