diff options
Diffstat (limited to 'doc/tex/systemDesign.tex')
| -rw-r--r-- | doc/tex/systemDesign.tex | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/doc/tex/systemDesign.tex b/doc/tex/systemDesign.tex index 3e82698..f0762e8 100644 --- a/doc/tex/systemDesign.tex +++ b/doc/tex/systemDesign.tex @@ -58,11 +58,11 @@ These classes and their relationships can be seen in \fref{fig:game}. \begin{figure}[h] \begin{center} \includegraphics[width=0.8\textwidth]{diagrams/engineModule.png} - \caption{Design of the GTP engine.}\label{fig:engine} + \caption{Design of the \acrshort{gtp} engine.}\label{fig:engine} \end{center} \end{figure} -An implementation of GTP, that is, the piece of software which offers the GTP +An implementation of \acrshort{gtp}, that is, the piece of software which offers the \acrshort{gtp} interface to other applications. It is designed to be used by a software controller but can also be directly run, mostly for debugging purposes. Its design is shown in \fref{fig:engine}. The core of the engine is related with @@ -258,7 +258,7 @@ respectively. \begin{figure}[h] \begin{center} \includegraphics[width=\textwidth]{diagrams/trainingModule.png} - \caption{Components of the SGF file parsing module.} + \caption{Components of the \acrshort{sgf} file parsing module.} \label{fig:trainingModule} Components not showing a capital C are not classes, as in they not follow the object-oriented paradigm and do not implement any classes, @@ -269,15 +269,15 @@ respectively. Neural networks can be powerful machine learning algorithms, but they have to be trained first so they can provide meaningful results. For a Go AI it makes sense to have its algorithms trained on Go games. There exists a common text format to -store Go games: SGF. If the system is able to process SGF files, it can provide +store Go games: \acrshort{sgf}. If the system is able to process \acrshort{sgf} files, it can provide the games stored on them to the neural networks for training. And so the need -for an SGF parser arises. +for an \acrshort{sgf} parser arises. -To parse SGF files a lexer and parser have been implemented using PLY.\@ The +To parse \acrshort{sgf} files a lexer and parser have been implemented using PLY.\@ The result of the parsing is an AST (Annotated Syntax Tree) reflecting the contents of the text input, each node with zero or more properties, and with the ability to convert themselves and their corresponding subtree into a GameMove tree. This -is done for the root node, since from the SGF specification there are some +is done for the root node, since from the \acrshort{sgf} specification there are some properties only usable in the root node, like those which specify general game information and properties such as rank of players or \gls{komi}. @@ -287,19 +287,19 @@ solved. These components are shown in \fref{fig:trainingModule}. \begin{itemize} - \item \textbf{SGF}: Provides a high-level method to convert a path to a SGF + \item \textbf{\acrshort{sgf}}: Provides a high-level method to convert a path to a \acrshort{sgf} file to a GameMove tree. - \item \textbf{sgfyacc}: The implementation of a SGF parser using PLY. Takes + \item \textbf{sgfyacc}: The implementation of a \acrshort{sgf} parser using PLY. Takes the tokens generated by \textbf{sgflex} and creates an ASTNode tree from them. - \item \textbf{sgflex}: The implementation of a SGF lexer using PLY.\@ Takes - text input and generates the tokens of the SGF language from them. + \item \textbf{sgflex}: The implementation of a \acrshort{sgf} lexer using PLY.\@ Takes + text input and generates the tokens of the \acrshort{sgf} language from them. - \item \textbf{ASTNode}: The AST resulting from the parsing of a SGF file. + \item \textbf{ASTNode}: The AST resulting from the parsing of a \acrshort{sgf} file. Has a method to convert it to a tree of GameMove and so obtain the - contents of the SGF in the internal representation used by the project's + contents of the \acrshort{sgf} in the internal representation used by the project's systems. \item \textbf{Property}: The representation of a property of an ASTNode @@ -313,7 +313,7 @@ The training can be started with the executable \texttt{train.py}. %\subsection{Modules} % %One module to store the state of the game and the game tree. One module to parse -%moves. One module to read and write SGF files. Modules are shown in +%moves. One module to read and write \acrshort{sgf} files. Modules are shown in %\fref{fig:modules}. % %\begin{figure}[h] |