Added info about modularity

Signed-off-by: Jim Martens <github@2martens.de>
This commit is contained in:
Jim Martens 2019-08-05 15:52:55 +02:00
parent 037fa10239
commit eef43bf9a6
1 changed files with 14 additions and 0 deletions

View File

@ -611,6 +611,20 @@ Furthermore, it is configurable, well documented, and conforms
to the clean code guidelines: evolvability and extendability among
others. Unit tests are part of the code as well to identify common
issues early on, saving time in the process.
% TODO: Unit tests (!)
The code was designed to be modular: One module creates the command
line interface (main.py), another implements the actions
chosen in the CLI (cli.py), the MS COCO to SceneNet RGB-D mapping can
be found in the definitions.py module,
preparation of the data sets and retrieval of data is
grouped in the data.py module, evaluation metrics have
their separate module (evaluation.py), the configuration is
accessed and handled by the config.py module, debug-only code
can be found in debug.py, and the ssd.py module contains
code to train the SSD and later predict with it. All
code relating to the auto-encoder can be found in its own
sub directory.
Lastly, the SSD implementation from a third party repository
has been modified to work inside a Python package architecture and