aboutsummaryrefslogtreecommitdiff
path: root/doc/tex/planning.tex
diff options
context:
space:
mode:
Diffstat (limited to 'doc/tex/planning.tex')
-rw-r--r--doc/tex/planning.tex57
1 files changed, 35 insertions, 22 deletions
diff --git a/doc/tex/planning.tex b/doc/tex/planning.tex
index 5d73ec3..17d413f 100644
--- a/doc/tex/planning.tex
+++ b/doc/tex/planning.tex
@@ -1,7 +1,7 @@
\section{Planning}
-This section explains the aim of the project, its reach, the existing work it is
-based on and an initial planning.
+This section explains the aim of the project, its reach and the existing work it
+is based on, and presents an initial planning.
\subsection{Project Stages}
@@ -123,20 +123,20 @@ presents a great resource for this project. The logo of the project is shown on
\paragraph{GnuGo \cite{gnugo}}
-A software capable of playing Go part of the GNU project. Although not a strong
-engine anymore, it is interesting for historic reasons as the free software
-engine for which the \acrshort{gtp} protocol was first defined. The logo of the
+A software capable of playing Go and part of the GNU project. Although not a
+strong engine anymore, it is interesting for historic reasons as the free
+software engine for which the \acrfull{gtp} was first defined. The logo of the
project is shown on \fref{fig:gnuGoLogo}.
\subsubsection{Existing Standards}
\paragraph{\acrshort{gtp} \cite{gtp}}
-\acrshort{gtp} (\textit{\acrlong{gtp}}) is a text based protocol for
-communication with computer Go programs. It is the protocol used by GNU Go and
-the more modern and powerful KataGo. By supporting \acrshort{gtp} the engine
-developed for this project can be used with existing GUIs and other programs,
-making it easier to use it with the tools users are already familiar with.
+The \acrfull{gtp} is a text based protocol for communication with computer Go
+programs. It is the protocol used by GNU Go and the more modern and powerful
+KataGo. By supporting \acrshort{gtp} the engine developed for this project can
+be used with existing GUIs and other programs, making it easier to be used with
+the tools target users are already familiar with.
%TODO
%\begin{listing}[h]
@@ -147,23 +147,36 @@ making it easier to use it with the tools users are already familiar with.
\paragraph{\acrshort{sgf} \cite{sgf}}
-\acrshort{sgf} (\textit{\acrlong{sgf}}) is a text format widely used for storing
-records of Go matches which allows for variants, comments and other metadata. It
-was devised for Go but it supports other games with similar turn-based
-structure. Many popular playing tools use it. By supporting \acrshort{sgf} vast
-existing collections of games, such as those played on online Go servers, can be
-used to train the decision algorithms based on neural networks. An example of a
-\acrshort{sgf} file can be seen on \lref{lst:sgfExample}.
+The \acrfull{sgf} is a text format widely used for storing records of Go matches
+which allows for variants, comments and other metadata. It was devised for Go
+but it supports other games with similar turn-based structure. Many popular
+playing tools use it. By supporting \acrshort{sgf} vast existing collections of
+games, such as those played on online Go servers, can be used to train the
+decision algorithms based on neural networks. An example of a \acrshort{sgf}
+file can be seen on \lref{lst:sgfExample}. The game state described in this file
+is shown visually in \fref{fig:sgfExample}.
\begin{listing}[h]
\inputminted[breakafter=\]]{text}{listings/sgfExample.sgf}
- \caption{\acrshort{sgf} example. Describes a \gls{tsumego} (Go problem) setup and two
- variants, one commented as "Correct" and other commented as "Incorrect".}
- \label{lst:sgfExample}
+ \caption{\acrshort{sgf} example. Describes a \gls{tsumego} (Go problem)
+ setup and two variants, one commented as "Correct" and other commented as
+ "Incorrect".
+ }\label{lst:sgfExample}
\end{listing}
\begin{figure}[h]
\begin{center}
+ \includegraphics[width=0.5\textwidth]{img/sgfExample.png}
+ \caption{Screenshot of Sabaki showing the \gls{tsumego} described in the
+ \acrshort{sgf} example from \lref{lst:sgfExample}. Note that Sabaki
+ marks the two continuations described in the \acrshort{sgf} file with
+ two transparent grey dots.
+ }\label{fig:sgfExample}
+ \end{center}
+\end{figure}
+
+\begin{figure}[h]
+ \begin{center}
\includegraphics[width=0.5\textwidth]{img/sabaki.jpg}
\caption{Sabaki screenshot.
https://sabaki.yichuanshen.de/img/screenshot.png
@@ -217,8 +230,8 @@ choice is Python \cite{python}, for various reasons:
Both the game and the engine will offer a text interface. For the game this
allows for quick human testing. For the engine it is mandated by the protocol,
since \acrshort{gtp} is a text based protocol for programs using text
-interfaces. Independent programs compatible with this interface can be used as a
-GUI.
+interfaces. Independent programs compatible with this interface will be able to
+be used in conjunction with this engine, for example to serve as a GUI.
There is also the need of an interface with \acrshort{sgf} files so existing
games can be processed by the trainer.