Skip to content

docs: 更新 README 安装、围棋训练与压测说明 - #4

Merged
Barbatosishere merged 1 commit into
mainfrom
docs/readme-training-guide
Oct 8, 2026
Merged

Barbatosishere merged 1 commit into
mainfrom
docs/readme-training-guide

Conversation

@Barbatosishere

Copy link
Copy Markdown
Owner

README 的安装示例仍引用 beta5,合成配方多写了两块铁锭,也缺少围棋模型、GPU 和训练任务的使用说明。本文档按当前源码及成品 JAR 修正这些内容,补充可复制的命令、参数默认值和最近的验证结果。

  • 更新安装、物品获取、实际 beta6 产物路径及 Windows/Linux/macOS 构建和测试命令。
  • 补充 JSON 模型配置、GPU 探测与 CPU 回退、自对弈和 KataGo 对抗训练;说明续训恢复范围、路径空格限制及截断棋局处理。
  • 记录代码提交 5c90d39 的 227 项测试和 RTX 2060 压测结果,说明硬件测试跳过规则与验证范围。

验证:已核对源码中的任务名称、示例参数、默认值,解析 JSON 示例,检查本地链接、Markdown 代码块、游戏数量及 git diff --cached --check;合成配方与产物名已对照构建 JAR。此提交仅修改 README,未重复运行代码测试。

Comment thread README.md

一个 Minecraft 模组,为游戏添加一台便携式游戏机,内含 **32 款**经典小游戏。

[安装与使用](#-使用方法) · [围棋 AI 与设置](#围棋-ai-与设置) · [构建与测试](#-构建与测试) · [围棋训练](#围棋训练)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

WARNING: TOC anchors with Chinese characters may not resolve correctly on GitHub

GitHub's anchor generation for non-ASCII headings (e.g., #-使用方法, #围棋-ai-与设置) produces percent-encoded URLs that can be inconsistent across platforms. Consider using ASCII-only anchors or adding explicit HTML anchors like <a id="installation"></a> before each heading.


Reply with @kilocode-bot fix it to have Kilo Code address this issue.

Comment thread README.md
"mctsIterations": 500,
"komi": 7.5,
"gpu": true,
"modelPath": "D:/models/go.nev"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

WARNING: Windows-specific path example without cross-platform alternative

The example uses D:/models/go.nev which is Windows-only. Linux/macOS users need guidance on path format (e.g., /home/user/models/go.nev). Since the docs later note paths must not contain spaces, add a cross-platform note here.


Reply with @kilocode-bot fix it to have Kilo Code address this issue.

Comment thread README.md
.\gradlew.bat test --no-daemon --tests '*GoGpuStressTest' --tests '*OpenCLLifecycleRegressionTest'
```

2026-10-07,在提交 `5c90d39` 对应代码上完成全量构建与 **227 项测试**,0 失败、0 跳过。RTX 2060 上验证了 24 线程、3,072 次并发推理,12 次 GPU/CPU 训练更新,6 轮 OpenCL 上下文创建与释放,以及批次大小 1/64/65/3/129/2 的扩缩容。新增硬件测试在没有可用 GPU 时会跳过,查看报告中的跳过数量可确认本机是否实际执行了设备测试;这些结果不代表其他显卡、驱动或整局棋力的验证。

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

WARNING: Potentially misleading test result statement

States "227 项测试,0 失败、0 跳过" but then notes hardware tests skip when GPU unavailable. On machines without GPU (e.g., CI), tests will be skipped. Clarify that "0 跳过" applies only to the RTX 2060 validation run, not universally.


Reply with @kilocode-bot fix it to have Kilo Code address this issue.

Comment thread README.md
```json
{
"go": {
"searchTime": 1000,

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

WARNING: Inconsistent searchTime defaults between JSON config, in-game AI, and training CLI

  • JSON example: searchTime: 1000
  • Training CLI table default: --searchTime 300
  • In-game AI (MCTSGoAI.DEFAULT_SEARCH_TIME): 3000ms

These are three different values for conceptually related settings. Document which default applies where, or align the example with the in-game default (3000).


Reply with @kilocode-bot fix it to have Kilo Code address this issue.

Comment thread README.md
{
"go": {
"searchTime": 1000,
"mctsIterations": 500,

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

WARNING: Naming inconsistency: JSON uses mctsIterations but CLI uses --iterations

The JSON config key is mctsIterations (read by MCTSGoAI line 170) while the training CLI parameter is --iterations (parsed into maxIterations in GoSelfPlayTrainer). They map to the same internal value but the naming difference will confuse users. Document the mapping or use consistent naming.


Reply with @kilocode-bot fix it to have Kilo Code address this issue.

Comment thread README.md

# 产物位于 build/libs/Game Console-1.0.0-NeoForge-1.21.1-beta5.jar
```powershell
.\gradlew.bat test --no-daemon --tests '*GoGpuStressTest' --tests '*OpenCLLifecycleRegressionTest'

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SUGGESTION: Missing Linux/macOS variant for GPU stress test command

Only PowerShell command shown for GoGpuStressTest and OpenCLLifecycleRegressionTest. Add bash equivalent for parity with the build commands above.


Reply with @kilocode-bot fix it to have Kilo Code address this issue.

Comment thread README.md

## 围棋训练

训练任务从源码目录运行,无需启动 Minecraft。以下使用 PowerShell;Linux / macOS 将 `.\gradlew.bat` 替换为 `bash ./gradlew`。当前任务按空白拆分 `trainArgs` / `advArgs`,参数中的文件路径请使用不含空格的路径。

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

WARNING: Path spacing limitation buried in training section

"参数中的文件路径请使用不含空格的路径" is a significant limitation (Gradle splits args on whitespace). This should be highlighted earlier (e.g., in the JSON config section) and mentioned for --weights, --katago, --katagoModel, --katagoConfig paths.


Reply with @kilocode-bot fix it to have Kilo Code address this issue.

Comment thread README.md

`searchTime` 单位为毫秒。导入后重新创建围棋对局以加载模型和搜索设置;修改 GPU 开关后重启客户端。没有有效模型文件时,内置 AI 使用随机初始化的网络权重,训练效果和棋力需要另行评估。

GPU 加速需要驱动提供支持双精度运算的 OpenCL 设备。GPU 不可用时自动回退 CPU;初始化失败后会在冷却 30 秒后的下一次尝试中重新探测。模组 JAR 不内嵌 JNA,游戏运行时使用环境提供的 JNA;Gradle 的训练和测试任务会添加所需运行依赖。

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

WARNING: JNA not bundled in mod JAR - runtime dependency on user environment

"模组 JAR 不内嵌 JNA,游戏运行时使用环境提供的 JNA" means users without JNA in their classpath will silently fall back to CPU. This should be called out more prominently as a known limitation/installation requirement for GPU acceleration.


Reply with @kilocode-bot fix it to have Kilo Code address this issue.

Comment thread README.md
1. 确保已安装 [NeoForge](https://neoforged.net/) 1.21.1
2. 将 `Game Console-1.0.0-NeoForge-1.21.1-beta5.jar` 放入 `.minecraft/mods` 文件夹
3. 启动游戏,在创造模式物品栏「游戏机」分类中获取游戏机
1. 使用 Java 21,安装 Minecraft 1.21.1 和 [NeoForge](https://neoforged.net/);当前构建使用 NeoForge 21.1.241。

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SUGGESTION: Hardcoded NeoForge version will become outdated

"当前构建使用 NeoForge 21.1.241" duplicates neo_version from gradle.properties. Consider referencing the property or stating "see build.gradle for current version" to avoid drift.


Reply with @kilocode-bot fix it to have Kilo Code address this issue.

Comment thread README.md
另行准备 [KataGo](https://github.com/lightvector/KataGo) 可执行文件、兼容的模型和 GTP 配置,修改以下示例路径:

```powershell
.\gradlew.bat adversarialTrain --no-daemon "-PadvArgs=--weights data/go.nev --katago D:/katago/katago.exe --katagoModel D:/katago/model.bin.gz --katagoConfig D:/katago/gtp.cfg --games 4 --parallelism 2 --generations 5 --epochs 1 --learningRate 0.001 --gpu true"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SUGGESTION: adversarialTrain example uses non-default parameter values

Example shows --games 4 --parallelism 2 --generations 5 but text states "对抗训练默认每代 10 局、并行 5 局". Either update the example to match defaults or explicitly note these are reduced for demo purposes.


Reply with @kilocode-bot fix it to have Kilo Code address this issue.

@kilo-code-bot

kilo-code-bot Bot commented Oct 7, 2026 •

Copy link
Copy Markdown

Code Review Summary

Status: 10 Issues Found | Recommendation: Address before merge

Overview

Severity Count
CRITICAL 0
WARNING 8
SUGGESTION 2
Issue Details (click to expand)

WARNING

File Line Issue
README.md 5 TOC anchors with Chinese characters may not resolve correctly on GitHub
README.md 111 Windows-specific path example without cross-platform alternative
README.md 149 Potentially misleading test result statement (0 skipped only on GPU machine)
README.md 107 Inconsistent searchTime defaults: JSON example 1000, CLI default 300, in-game default 3000
README.md 108 Naming inconsistency: JSON uses mctsIterations but CLI uses --iterations
README.md 153 Path spacing limitation buried in training section (Gradle splits on whitespace)
README.md 118 JNA not bundled in mod JAR - silent CPU fallback if missing
README.md 194 adversarialTrain example uses non-default parameter values vs documented defaults

SUGGESTION

File Line Issue
README.md 146 Missing Linux/macOS variant for GPU stress test command
README.md 83 Hardcoded NeoForge version will become outdated
Files Reviewed (1 file)
  • README.md - 10 issues

Fix these issues in Kilo Cloud


Reviewed by free · Input: 580.6K · Output: 10.2K · Cached: 509.8K

@Barbatosishere
Barbatosishere merged commit 693acc7 into main Oct 8, 2026
2 checks passed
@Barbatosishere
Barbatosishere deleted the docs/readme-training-guide branch October 16, 2026 04:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant