Added doc comments to public functions in cli module

Signed-off-by: Jim Martens <github@2martens.de>
This commit is contained in:
2019-09-02 13:23:10 +02:00
parent a8d64ce9c2
commit 8aac3ae30f

View File

@ -44,10 +44,12 @@ from twomartens.masterthesis import config as conf
def config(args: argparse.Namespace) -> None: def config(args: argparse.Namespace) -> None:
"""Executes the config action from the CLI."""
_config_execute_action(args, conf.get_property, conf.set_property, conf.list_property_values) _config_execute_action(args, conf.get_property, conf.set_property, conf.list_property_values)
def prepare(args: argparse.Namespace) -> None: def prepare(args: argparse.Namespace) -> None:
"""Executes the prepare action from the CLI."""
import pickle import pickle
from twomartens.masterthesis import data from twomartens.masterthesis import data
@ -69,15 +71,18 @@ def prepare(args: argparse.Namespace) -> None:
def train(args: argparse.Namespace) -> None: def train(args: argparse.Namespace) -> None:
"""Executes the train action from the CLI."""
_train_execute_action(args, _ssd_train) _train_execute_action(args, _ssd_train)
def test(args: argparse.Namespace) -> None: def test(args: argparse.Namespace) -> None:
"""Executes the test action from the CLI."""
if args.network == "ssd" or args.network == "bayesian_ssd": if args.network == "ssd" or args.network == "bayesian_ssd":
_ssd_test(args) _ssd_test(args)
def evaluate(args: argparse.Namespace) -> None: def evaluate(args: argparse.Namespace) -> None:
"""Executes the evaluate action from the CLI."""
if args.network == "ssd" or args.network == "bayesian_ssd": if args.network == "ssd" or args.network == "bayesian_ssd":
_ssd_evaluate(args) _ssd_evaluate(args)
else: else:
@ -85,6 +90,7 @@ def evaluate(args: argparse.Namespace) -> None:
def visualise(args: argparse.Namespace) -> None: def visualise(args: argparse.Namespace) -> None:
"""Executes the visualise action from the CLI."""
from twomartens.masterthesis.ssd_keras.eval_utils import coco_utils from twomartens.masterthesis.ssd_keras.eval_utils import coco_utils
output_path, coco_path, ground_truth_path = _visualise_get_config_values(conf.get_property) output_path, coco_path, ground_truth_path = _visualise_get_config_values(conf.get_property)
@ -99,6 +105,7 @@ def visualise(args: argparse.Namespace) -> None:
def visualise_metrics(args: argparse.Namespace) -> None: def visualise_metrics(args: argparse.Namespace) -> None:
"""Executes the visualise_metrics action from the CLI."""
output_path, evaluation_path = _visualise_metrics_get_config_values(conf.get_property) output_path, evaluation_path = _visualise_metrics_get_config_values(conf.get_property)
output_path, metrics_file = _visualise_metrics_prepare_paths(args, output_path, evaluation_path) output_path, metrics_file = _visualise_metrics_prepare_paths(args, output_path, evaluation_path)
_visualise_metrics(_visualise_precision_recall, _visualise_ose_f1, _visualise_metrics(_visualise_precision_recall, _visualise_ose_f1,
@ -106,6 +113,7 @@ def visualise_metrics(args: argparse.Namespace) -> None:
def measure_mapping(args: argparse.Namespace) -> None: def measure_mapping(args: argparse.Namespace) -> None:
"""Executes the measure_mapping action from the CLI."""
from twomartens.masterthesis.ssd_keras.eval_utils import coco_utils from twomartens.masterthesis.ssd_keras.eval_utils import coco_utils
output_path, coco_path, ground_truth_path = _measure_get_config_values(conf.get_property) output_path, coco_path, ground_truth_path = _measure_get_config_values(conf.get_property)