Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JannisHoch committed Sep 30, 2020
1 parent 8c4df93 commit bb199c7
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
6 changes: 5 additions & 1 deletion docs/Output.rst
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/model_settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit bb199c7

Please sign in to comment.