From 86e4dc07246cb2db5101b807f4f9db547dec96c1 Mon Sep 17 00:00:00 2001 From: enz Date: Thu, 5 Mar 2009 23:06:06 +0000 Subject: [PATCH] Add Fuego user manual git-svn-id: svn://svn.code.sf.net/p/fuego/code/trunk@804 2e953b5c-c64d-0410-be54-f773e93e544c --- Makefile.am | 4 +- README | 13 +++- doc/manual/index.html | 160 ++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 174 insertions(+), 3 deletions(-) create mode 100644 doc/manual/index.html diff --git a/Makefile.am b/Makefile.am index 334c0690..c10a932e 100644 --- a/Makefile.am +++ b/Makefile.am @@ -56,4 +56,6 @@ doc/doxygen/simpleplayers/pages/mainpage.cpp \ doc/doxygen/smartgame/Makefile \ doc/doxygen/smartgame/doxygen.cfg \ doc/doxygen/smartgame/pages/mainpage.cpp \ -doc/doxygen/smartgame/pages/sgnotes.cpp +doc/doxygen/smartgame/pages/sgnotes.cpp \ +doc/manual/index.html + diff --git a/README b/README index eb1bd425..8be05e41 100644 --- a/README +++ b/README @@ -38,5 +38,14 @@ Compilation =========== See INSTALL for generic compilation instructions from GNU Automake. -The file doc/general/pages/autotools.cpp contains additional and Fuego -specific documentation. +The file doc/doxygen/general/pages/autotools.cpp contains additional and +Fuego specific documentation. + +Documentation +============= + +The developer documentation for the libraries and applications can be +created with Doxygen (http://www.doxygen.org). There is a makefile in +doc/doxygen/Makefile. + +The user manual for the main Go player is in doc/manual/ diff --git a/doc/manual/index.html b/doc/manual/index.html new file mode 100644 index 00000000..c8b7af43 --- /dev/null +++ b/doc/manual/index.html @@ -0,0 +1,160 @@ + + +Fuego User Manual + + + +

Fuego User Manual

+ +

Graphical User Interface

+ +

+Fuego is a Go playing engine, which communicates to a user interface using +the Go Text Protocol (GTP). +You need a graphical user interface that supports GTP to play against Fuego. +The recommended one is GoGui because +Fuego uses some of the special features of GoGui. +The most important feature is the Analyze Command window, which makes +engine-specific GTP extension commands accessible in the user interface. +These commands allow to query and display internal information about the +move generation and to set engine parameters. +Some of these are only of interest to engine developers, some of them might +also be useful for users. +

+ +

Configuring Fuego for Your Machine

+ +

+The default configuration for Fuego makes conservative assumptions about +the available computing power and memory. +You can increase the playing strength of Fuego by using parallel search +on a mulit-core or multi-CPU machine and by increasing the amount of memory +to use. +Parameters can be changed with certain commands in the analyze window of +GoGui, but this will affect only the current session. +To optimize the default configuration for a certain machine in a persisent +way, you can write a text file with GTP commands (e.g. configfile) +and change the command line for invocation of Fuego in the user interface to +fuego -config configfile. Here is an example of such a configuration +file: +

+ +
+
+uct_param_search number_threads 2
+uct_param_search lock_free 1
+uct_param_search max_nodes 12000000
+uct_param_player reuse_subtree 1
+uct_param_player ponder 1
+
+
+ +

+The meaning of these GTP commands is: +

+ +
+ +
uct_param_search number_threads
+
+The number of threads to use. +The default is 1. +This should be set to the number of cores or CPUs available on the system. +
+ +
uct_param_search lock_free
+
+Whether to enable lock-free multithreading. +The default is 0 (=no). +You should enable this on modern Intel or AMD CPUs (with IA-32 and Intel-64 +architecture) if more than two threads are used. +Note that without lock-free search the performance of Fuego can even decrease +if you use more threads. +The maximum number of threads that can be used without a decrease of +performance, if the lock-free mode is not used, depends on the board size. +
+ +
uct_param_search max_nodes
+
+Determines the maximum number of nodes in the search tree, and thus the +maximum memory to use. +The default is 4000000. +The node size is 48 bytes on 64-bit computers (and 28 bytes on 32-bit +computers). +Fuego maintains two search trees internally. +So you should use about 10000000 nodes per GB main memory that you want to +give to Fuego on 64-bit computers (and 15000000 per GB on 32-bit computers). +
+ +
uct_param_player reuse_subtree
+
+Whether to reuse the reusable part of the tree from a previous move +generation. +The default is 0 (=no). +Setting this to 1 (=yes) is required if pondering is used, but it also gives +a small improvement in playing strength if pondering is not used. +
+ +
uct_param_player ponder
+
+Whether to continue the search while waiting for the opponent's move. +The default is 0 (=no). +If this is set to 1, uct_param_player reuse_subtree must also be +enabled. +
+ +
+ +

Game-specific Settings

+ +

+This a list of some game-specific parameters, which can be changed in GoGui's +the analyze command window. +

+ +
+ +
Go Param
+
+There is one parameter that is interesting to users: +Timelimit is the fixed time limit in seconds to use for a move +generation, if no time settings are used for the game. +The default is 10. +
+ +
Go Param Rules
+
+Change the rules used in the game. +Note that entering text in the rules text entry of GoGui's game info dialog +is for storing this information in the file only. +It is not transmitted to the Go program because there is no GTP standard +command for setting the rules. +What rules are used by Fuego depends only on the settings in Go Param Rules. +
+ +
+ +

Watching Fuego's Thinking Process

+ +

+You can enable the display of Fuego's thinking process by setting +Live gfx in the Uct Param Search analyze command to +Counts or Sequence. +Counts will show the current exploration counts of the moves as labels on the +board and the currently best move using a half-transparent stone. +Sequence will show the current best sequence of moves using half-transparent +stones. +The display interval can be configured with Live gfx interval. +

+ +

+Another display mode is Live gfx in the +Uct Param GlobalSearch analyze command. +It shows the statistics for ownership of each point averaged over all end +positions of the simulations. +This command requires that Territor statistics in +Uct Param GlobalSearch is also enabled. +

+ + +