From 77764bee49c93a5d08d134cf7919b7f84a997e20 Mon Sep 17 00:00:00 2001
From: InigoGutierrez <inigogf.95@gmail.com>
Date: Sat, 25 Jun 2022 19:56:48 +0200
Subject: Back to the documentation after creating neural networks.

---
 doc/diagrams/interfaces.puml                  | 20 ++++++++++++
 doc/diagrams/planificationWorkPlanEngine.puml | 46 ++++++++++++++++++---------
 doc/diagrams/planificationWorkPlanGame.puml   | 22 ++++++++-----
 doc/diagrams/useCases.puml                    |  8 +++--
 4 files changed, 70 insertions(+), 26 deletions(-)
 create mode 100644 doc/diagrams/interfaces.puml

(limited to 'doc/diagrams')

diff --git a/doc/diagrams/interfaces.puml b/doc/diagrams/interfaces.puml
new file mode 100644
index 0000000..3ade81e
--- /dev/null
+++ b/doc/diagrams/interfaces.puml
@@ -0,0 +1,20 @@
+@startuml
+
+!include ./skinparams.puml
+
+component Game
+component Engine
+component Trainer
+
+interface "Game text interface" as GTI
+interface "Engine text interface" as ETI
+interface "Neural network model" as NNM
+interface "SGF files" as SGF
+
+Game -- GTI
+Engine -- ETI
+Engine -- NNM
+Trainer -- NNM
+Trainer -- SGF
+
+@enduml
diff --git a/doc/diagrams/planificationWorkPlanEngine.puml b/doc/diagrams/planificationWorkPlanEngine.puml
index 53bd5ea..fcdb3ba 100644
--- a/doc/diagrams/planificationWorkPlanEngine.puml
+++ b/doc/diagrams/planificationWorkPlanEngine.puml
@@ -4,27 +4,43 @@
 !include skinparamsGantt.puml
 
 'printscale weekly
+Saturday are closed
 Sunday are closed
 
-Project starts 2021-01-04
+Project starts 2021-01-11
+
+-- Preliminary research --
+[Previous works research] as [PWR] lasts 1 week
+[Algorithms research] as [AR] lasts 2 weeks
 
 -- Engine Implementation --
-[Engine modelling] as [EM] starts 2021-01-04
 [Engine modelling] as [EM] lasts 1 week
-[Engine implementation] as [EI] lasts 5 weeks
-[Engine testing] as [ET] lasts 5 weeks
+[Engine implementation] as [EI] lasts 4 weeks
 
 -- Algorithms Implementations --
-[Algorithm research] as [AR] lasts 1 week
-[Monte Carlo implementation] as [MCI] lasts 3 weeks
-[Extra algorithms research] as [EAR] lasts 2 weeks
-[Extra algorithms implementation] as [EAI] lasts 4 weeks
-
-[EM] -> [AR]
-[AR] -> [MCI]
-[AR] -> [EI]
-[AR] -> [ET]
-[EI] -> [EAR]
-[EAR] -> [EAI]
+[Monte Carlo implementation] as [MCI] lasts 4 weeks
+[Neural networks research] as [NNR] lasts 2 weeks
+[Neural networks implementation] as [NNI] lasts 3 weeks
+
+-- Testing --
+[Engine unit testing] as [EUT] lasts 4 weeks
+[System testing] as [ST] lasts 1 week
+
+-- Analysis --
+[Algorithms comparison] as [AC] lasts 2 weeks
+
+[PWR] -> [AR]
+[AR] -> [EM]
+
+[EM] -> [MCI]
+[EM] -> [EI]
+[EM] -> [EUT]
+
+[MCI] -> [NNR]
+[NNR] -> [NNI]
+
+[NNI] -> [ST]
+
+[ST] -> [AC]
 
 @endgantt
diff --git a/doc/diagrams/planificationWorkPlanGame.puml b/doc/diagrams/planificationWorkPlanGame.puml
index 42b0821..fa09384 100644
--- a/doc/diagrams/planificationWorkPlanGame.puml
+++ b/doc/diagrams/planificationWorkPlanGame.puml
@@ -4,21 +4,27 @@
 !include skinparamsGantt.puml
 
 'printscale weekly
+Saturday are closed
 Sunday are closed
 
 Project starts 2020-11-02
 
--- Preliminary investigation --
-[Previous works investigation] as [PWI] lasts 7 days
-[Engines investigation] as [EI] lasts 7 days
+-- Preliminary research --
+[Previous works research] as [PWR] lasts 1 week
 
 -- Game Implementation --
-[Domain modelling] as [DM] lasts 6 days
-[Domain implementation] as [DI] lasts 30 days
-[Domain testing] as [DT] lasts 30 days
+[Domain modelling] as [DM] lasts 1 week
+[Domain implementation] as [DI] lasts 6 weeks
+
+-- Testing --
+[Unit testing] as [UT] lasts 6 weeks
+[System testing] as [ST] lasts 3 days
+
+[PWR] -> [DM]
 
-[PWI] -> [DM]
 [DM] -> [DI]
-[DM] -> [DT]
+[DM] -> [UT]
+
+[DI] -> [ST]
 
 @endgantt
diff --git a/doc/diagrams/useCases.puml b/doc/diagrams/useCases.puml
index e3da3f8..022bd4c 100644
--- a/doc/diagrams/useCases.puml
+++ b/doc/diagrams/useCases.puml
@@ -3,16 +3,18 @@
 !include skinparams.puml
 
 actor "Human Player" as player
-actor "Human User" as user
 actor "GUI Program" as gui
+actor "Human User" as user
 
 usecase "Play a match" as play
-usecase "Generate a move" as genMove
 usecase "Use as backend for machine player" as backend
+usecase "Generate a move" as genMove
+usecase "Train a neural network" as train
 
 player --> play
+gui --> backend
 user --> genMove
 gui --> genMove
-gui --> backend
+user --> train
 
 @enduml
-- 
cgit v1.2.1