mirror of
https://github.com/macaodha/batdetect2.git
synced 2026-07-07 21:00:10 +02:00
docs: clarify CLI log file option
This commit is contained in:
parent
0a8787e5f1
commit
89aa74afde
@ -17,6 +17,8 @@ for the full option list.
|
|||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
- Global CLI options are documented in {doc}`base`.
|
- Global CLI options are documented in {doc}`base`.
|
||||||
|
- Use `--log-file path/to/cli.log` to save CLI logs to a file while still
|
||||||
|
showing them in the terminal.
|
||||||
- Paths with spaces should be wrapped in quotes.
|
- Paths with spaces should be wrapped in quotes.
|
||||||
- Input audio is expected to be mono.
|
- Input audio is expected to be mono.
|
||||||
- `process` uses the optional `--detection-threshold` override.
|
- `process` uses the optional `--detection-threshold` override.
|
||||||
|
|||||||
@ -97,6 +97,23 @@ What this does:
|
|||||||
- runs the model on each recording,
|
- runs the model on each recording,
|
||||||
- saves the results in `path/to/outputs`.
|
- saves the results in `path/to/outputs`.
|
||||||
|
|
||||||
|
```{eval-rst}
|
||||||
|
.. admonition:: Save CLI logs to a file
|
||||||
|
:collapsible: closed
|
||||||
|
:class: tip dropdown
|
||||||
|
|
||||||
|
If you want to keep a copy of the CLI logs, add ``--log-file`` before the
|
||||||
|
subcommand:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
batdetect2 --log-file path/to/cli.log process directory \
|
||||||
|
path/to/audio \
|
||||||
|
path/to/outputs
|
||||||
|
|
||||||
|
This writes the same CLI logs to ``path/to/cli.log`` and to the terminal.
|
||||||
|
```
|
||||||
|
|
||||||
You do not need to choose a model for this first run.
|
You do not need to choose a model for this first run.
|
||||||
If you do nothing, BatDetect2 uses the built-in default UK model.
|
If you do nothing, BatDetect2 uses the built-in default UK model.
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user