aboutsummaryrefslogtreecommitdiff
path: root/doc/tex/systemAnalysis.tex
diff options
context:
space:
mode:
Diffstat (limited to 'doc/tex/systemAnalysis.tex')
-rw-r--r--doc/tex/systemAnalysis.tex29
1 files changed, 14 insertions, 15 deletions
diff --git a/doc/tex/systemAnalysis.tex b/doc/tex/systemAnalysis.tex
index 3668f4e..bbae66e 100644
--- a/doc/tex/systemAnalysis.tex
+++ b/doc/tex/systemAnalysis.tex
@@ -16,10 +16,10 @@ These are the main goals the final product must reach.
code.
\item An engine program as a way of presenting an interface for using these
- algorithms. The engine will use the GTP so it can be used with an
+ algorithms. The engine will use the \acrshort{gtp} so it can be used with an
existing GUI or other tools.
- \item A parser for SGF files so they can be processed in the training of
+ \item A parser for \acrshort{sgf} files so they can be processed in the training of
neural networks.
\end{enumerate}
@@ -84,8 +84,7 @@ requisites needed for the system.
\item The engine program is interactive.
- \item The engine implements the GTP (\textit{Go Text Protocol}) for its
- interface.
+ \item The engine implements the \acrfull{gtp} for its interface.
\begin{enumerate}
\item Commands are read from standard input.
\item Responses are provided via standard output.
@@ -149,7 +148,7 @@ requisites needed for the system.
\item The trainer can import existing games.
\begin{enumerate}
- \item Records of games stored as SGF can be imported.
+ \item Records of games stored as \acrshort{sgf} can be imported.
\item Files containing records of games are provided as arguments to
the trainer.
\end{enumerate}
@@ -264,16 +263,16 @@ between human players to show and test its capabilities.
\subsubsection{Engine System}
-The Engine System will implement the GTP interface and use the Game System to
+The Engine System will implement the \acrshort{gtp} interface and use the Game System to
analyse positions and generate moves via decision algorithms.
This system can be directly called to manually set up game states and ask for
-moves or can be called by other programs which use GTP to be used as backend for
+moves or can be called by other programs which use \acrshort{gtp} to be used as backend for
playing matches against a computer player.
\subsubsection{Training System}
-The Training System will process SGF files storing records of games, train the
+The Training System will process \acrshort{sgf} files storing records of games, train the
neural network models over those games and store the result. These models can
then be imported by the engine and be used to generate moves.
@@ -285,7 +284,7 @@ and uses it to train and store the neural network models.
Both the Engine and Training systems depend on the GameMove class of the Game
System. The Engine System uses it to store the state of a game and provide it
to the decision algorithms. The Training System uses it to create the internal
-representation of a game resulting from the processing of an SGF file.
+representation of a game resulting from the processing of an \acrshort{sgf} file.
\subsection{Class Analysis}
@@ -666,12 +665,12 @@ The classes resulting from the analysis phase are shown in
\textbf{Parser} \\
\midrule
\textbf{Description} \\
- Reads SGF files and converts them to a tree of GameMove from the Game
+ Reads \acrshort{sgf} files and converts them to a tree of GameMove from the Game
System. \\
\midrule
\textbf{Responsibilities} \\
- \tabitem{Read SGF files.} \\
- \tabitem{Convert the content of the SGF files to a tree of GameMove.} \\
+ \tabitem{Read \acrshort{sgf} files.} \\
+ \tabitem{Convert the content of the \acrshort{sgf} files to a tree of GameMove.} \\
\midrule
\textbf{Proposed attributes} \\
%TODO: Explain why this is empty
@@ -688,14 +687,14 @@ The classes resulting from the analysis phase are shown in
\textbf{ASTNode} \\
\midrule
\textbf{Description} \\
- Makes up the tree resulting from the parsing of an SGF file.\\
+ Makes up the tree resulting from the parsing of an \acrshort{sgf} file.\\
\midrule
\textbf{Responsibilities} \\
\tabitem{Obtain a GameMove tree from itself and its children.} \\
\midrule
\textbf{Proposed attributes} \\
\tabitem{\textbf{children}: The nodes following from itself.} \\
- \tabitem{\textbf{props}: The properties of the tree read from an SGF file.}
+ \tabitem{\textbf{props}: The properties of the tree read from an \acrshort{sgf} file.}
\\
\midrule
\textbf{Proposed methods} \\
@@ -746,7 +745,7 @@ against another machine player.
\paragraph{Generate a move}
The engine interface reads the input for generating a move as stated by the
-GTP protocol and outputs the coordinates of the board to play.
+\acrshort{gtp} protocol and outputs the coordinates of the board to play.
\subsection{Use Case Analysis and Scenarios}