From bb199c7fc606b7f29c7b3c4eb334a689bcba3b9d Mon Sep 17 00:00:00 2001 From: Jannis Date: Wed, 30 Sep 2020 15:51:13 +0200 Subject: [PATCH] updated docs --- docs/Output.rst | 6 +++++- docs/model_settings.rst | 2 +- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/Output.rst b/docs/Output.rst index 4d8c797..eceacf6 100644 --- a/docs/Output.rst +++ b/docs/Output.rst @@ -1,12 +1,16 @@ Output ========================= -The model produces a range of output files by default. Output is stored in the output folder. +The model can produce a range of output files. Output is stored in the output folder. .. note:: In addition to these output files, the model settings file (cfg-file) is automatically copied to the output folder. +.. important:: + + Not all model types provide the output mentioned below. If the 'leave-one-out' or 'single variable' model are selected, only the metrics are stored to a csv-file. + Selected polygons ------------------ A shp-file named ``selected_polygons.shp`` contains all polygons after performing the selection procedure. diff --git a/docs/model_settings.rst b/docs/model_settings.rst index 4b06e2e..b8a0abc 100644 --- a/docs/model_settings.rst +++ b/docs/model_settings.rst @@ -21,7 +21,7 @@ Additionally, the cfg-file included in the GitHub-repository already contains th .. note:: - the 'leave_one_out' and 'single_variables' models are only tested in beta-state. + the 'leave-one-out' and 'single variables' models are only tested in beta-state. They produce only limited output (see :ref:`Output`). - *verbose*: if True, model messages will be printed to screen.