Go to file
Jim Martens 029a2e2bb7 Moved templates to correct location
Signed-off-by: Jim Martens <github@2martens.de>
2019-10-01 18:27:56 +02:00
.github/ISSUE_TEMPLATE Moved templates to correct location 2019-10-01 18:27:56 +02:00
src Completed documentation 2019-10-01 17:19:32 +02:00
.editorconfig Added editorconfig 2019-02-04 16:23:13 +01:00
.gitignore Added _env to gitignore 2019-09-12 12:06:02 +02:00
.gitmodules Added ssd_keras sub-module 2019-03-19 17:21:09 +01:00
LICENSE Improved formatting of LICENSE file 2019-02-08 22:59:17 +01:00
MANIFEST.in Added pycocotools as dependency 2019-04-04 14:23:30 +02:00
README.md Fixed typo wrt master thesis 2019-10-01 17:38:49 +02:00
requirements.txt Added attributedict to dependencies 2019-09-02 16:55:02 +02:00
setup.py Updated README for PyPi release 2019-10-01 17:03:55 +02:00
sonar-project.properties Added SonarQube project properties 2019-09-02 13:23:33 +02:00

README.md

Masterthesis

Allows reproduction of results in my master thesis.

Downloads License Python versions

The package supports testing and evaluating SSD and Bayesian SSD. The results can be visualised.

Installation

pip install twomartens.masterthesis
pip install git+https://github.com/philferriere/cocoapi.git#egg=pycocotools&subdirectory=PythonAPI

The second line is important as Git dependencies cannot be specified in the setup.py file.

Please refer to GPU support for instructions on installing the non-Python dependencies for tensorflow.

Type the following to create the configuration file and to see the options:

tm-masterthesis config list

Especially the paths have to be set to the correct values.

Usage example

tm-masterthesis --help

Lists all available commands. As most commands are nested, it is advisable to request the help at different nesting levels.

tm-masterthesis config {get,set,list}

Allows for the modification and retrieval of the configuration values.

tm-masterthesis test {ssd,bayesian_ssd} iteration train_iteration

Tests the selected network, using iteration as identifier for the test run and train_iteration as identifier for the training iteration. If the config parameter ssd_test_pretrained is True then the training iteration is not relevant.

tm-masterthesis evaluate {ssd,bayesian_ssd} iteration

Runs the evaluation process using the test results identified by iteration, evaluation results are saved under iteration under the evaluation path.

tm-masterthesis visualise_metrics {ssd,bayesian_ssd} iteration

Uses the evaluation results stored under iteration and visualises it. The score JSON and the figure images are stored under iteration in a visualise folder under the output path.

There are more commands but the rest can be very tightly linked to requirements in the master thesis and might therefore not be of interest generally.

Development setup

Clone the repository locally. Then execute the following commands inside the repository:

git submodule init
git submodule update
pip install -e .
pip install git+https://github.com/philferriere/cocoapi.git#egg=pycocotools&subdirectory=PythonAPI

Release History

  • 0.1.0
    • first release

Meta

Jim Martens @2martens github@2martens.de

Distributed under the Apache 2.0 license. See LICENSE for more information. The package contains the ssd_keras implementation of Pierluigi Ferrari.

https://github.com/2martens/

Contributing

  1. Fork it (https://github.com/2martens/masterthesis/fork)
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Commit your changes (git commit -am 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new Pull Request