Skip to content

Commit 015c6bf

Browse files
silabsbotsilabsbot
committed
updated docs
1 parent f163d26 commit 015c6bf

File tree

274 files changed

+5066
-7408
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

274 files changed

+5066
-7408
lines changed

‎docs/_sources/docs/command_line/classify_audio_cli_help.md.txt

Lines changed: 73 additions & 181 deletions
Large diffs are not rendered by default.

‎docs/_sources/docs/command_line/classify_image_cli_help.md.txt

Lines changed: 61 additions & 126 deletions
Large diffs are not rendered by default.

‎docs/_sources/docs/command_line/evaluate_cli_help.md.txt

Lines changed: 53 additions & 148 deletions
Large diffs are not rendered by default.

‎docs/_sources/docs/command_line/fingerprint_reader_cli_help.md.txt

Lines changed: 34 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,41 @@
11
```text
2-
3-
Usage: mltk fingerprint_reader [OPTIONS] <model>
4-
5-
View/save fingerprints captured by the fingerprint eader connected to an
6-
embedded device.
7-
NOTE: A supported embedded device must be locally connected to use this
8-
command.
9-
Additionally, an R503 fingerprint module:
10-
https://www.adafruit.com/product/4651
11-
must be connected connected to the development board.
12-
Refer to the online documentation for how to connect it to the development:
13-
https://siliconlabs.github.io/mltk/docs/cpp_development/examples/fingerprint_
14-
authenticator.html#hardware-setup
15-
16-
For more details, ee:
17-
https://siliconlabs.github.io/mltk/mltk/tutorials/fingerprint_authentication
18-
2+
3+
Usage: mltk fingerprint_reader [OPTIONS] <model>
4+
5+
View/save fingerprints captured by the fingerprint eader connected to an embedded device.
6+
NOTE: A supported embedded device must be locally connected to use this command.
7+
Additionally, an R503 fingerprint module: https://www.adafruit.com/product/4651
8+
must be connected connected to the development board.
9+
Refer to the online documentation for how to connect it to the development:
10+
https://siliconlabs.github.io/mltk/docs/cpp_development/examples/fingerprint_authenticator.html#hardware-setup
11+
12+
For more details, ee:
13+
https://siliconlabs.github.io/mltk/mltk/tutorials/fingerprint_authentication
14+
1915
Arguments
20-
* model <model> On of the following:
21-
- MLTK model name
22-
- Path to .tflite file
23-
- Path to model archive file (.mltk.zip)
24-
NOTE: The model must have been previously trained
25-
for image classification
26-
[default: None]
27-
[required]
16+
* model <model> On of the following: [default: None] [required]
17+
- MLTK model name
18+
- Path to .tflite file
19+
- Path to model archive file (.mltk.zip)
20+
NOTE: The model must have been previously trained for image classification
2821

2922
Options
30-
--accelerator -a <name> Name of accelerator to use while
31-
executing the audio classification
32-
ML model
33-
[default: None]
34-
--port <port> Serial COM port of a locally
35-
connected embedded device.
36-
'If omitted, then attempt to
37-
automatically determine the serial
38-
COM port
39-
[default: None]
40-
--verbose -v Enable verbose console logs
41-
--generate-dataset -g Generate a fingerprint dataset by
42-
guiding the user through a sequence
43-
of finger captures and saving to the
44-
PC.
45-
NOTE: With this option,
46-
--no-inference is automatically
47-
enabled
48-
--samples-per-finger -c INTEGER The number of samples per finger to
49-
collect when generating the dataset
50-
[default: 5]
51-
--dataset-dir TEXT Base directory where dataset should
52-
be generated
53-
[default: None]
54-
--dump-images -d Dump the raw images from the device
55-
fingerprint reader to a directory on
56-
the local PC.
57-
--no-inference -z By default inference is executed on
58-
the device. Use --no-inference to
59-
disable inference on the device
60-
which can improve dumping throughput
61-
--app <path> By default, the
62-
fingerprint_authenticator app is
63-
automatically downloaded.
64-
This option allows for overriding
65-
with a custom built app.
66-
Alternatively, set this option to
67-
"none" to NOT program the
68-
fingerprint_authenticator app to the
69-
device.
70-
In this case, ONLY the .tflite will
71-
be programmed and the existing
72-
fingerprint_authenticator app will
73-
be re-used.
74-
[default: None]
75-
--test Run as a unit test
76-
--help Show this message and exit.
23+
--accelerator -a <name> Name of accelerator to use while executing the audio classification ML model [default: None]
24+
--port <port> Serial COM port of a locally connected embedded device. [default: None]
25+
'If omitted, then attempt to automatically determine the serial COM port
26+
--verbose -v Enable verbose console logs
27+
--generate-dataset -g Generate a fingerprint dataset by guiding the user through a sequence of finger captures and saving to the PC.
28+
NOTE: With this option, --no-inference is automatically enabled
29+
--samples-per-finger -c INTEGER The number of samples per finger to collect when generating the dataset [default: 5]
30+
--dataset-dir TEXT Base directory where dataset should be generated [default: None]
31+
--dump-images -d Dump the raw images from the device fingerprint reader to a directory on the local PC.
32+
--no-inference -z By default inference is executed on the device. Use --no-inference to disable inference on the device which can improve dumping throughput
33+
--app <path> By default, the fingerprint_authenticator app is automatically downloaded. [default: None]
34+
This option allows for overriding with a custom built app.
35+
Alternatively, set this option to "none" to NOT program the fingerprint_authenticator app to the device.
36+
In this case, ONLY the .tflite will be programmed and the existing fingerprint_authenticator app will be re-used.
37+
--test Run as a unit test
38+
--help Show this message and exit.
7739

7840

7941
```

0 commit comments

Comments
 (0)