Skip to content

Commit

Permalink
usage.rst: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mariehbourget committed Jul 12, 2022
1 parent e696e1f commit b6cb971
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/source/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,10 @@ Note that both path CLI flags are optional and can be specified instead via the
If not set via CLI, then you MUST specify this field in the configuration file.

Please see section ``TUTORIALS`` to run this command on an example dataset.

Additional optional flags with ``--segment`` command for models trained with 2D patches:

``--no-patch``: 2D patches are not used while segmenting with models trained with patches. The ``--no-patch`` argument supersedes the
``--overlap-2d`` argument.

``--overlap-2d``: Custom overlap for 2D patches while segmenting. Example: ``--overlap-2d 48 48`` for an overlap of 48 pixels between patches in X and Y respectively. Default model overlap is used otherwise.

0 comments on commit b6cb971

Please sign in to comment.