updated docs

SiliconLabs · Mar 2, 2023 · 015c6bf · 015c6bf
1 parent f163d26
commit 015c6bf
Show file tree

Hide file tree

Showing 274 changed files with 5,066 additions and 7,408 deletions.
diff --git a/docs/_sources/docs/command_line/classify_audio_cli_help.md.txt b/docs/_sources/docs/command_line/classify_audio_cli_help.md.txt
diff --git a/docs/_sources/docs/command_line/classify_image_cli_help.md.txt b/docs/_sources/docs/command_line/classify_image_cli_help.md.txt
diff --git a/docs/_sources/docs/command_line/evaluate_cli_help.md.txt b/docs/_sources/docs/command_line/evaluate_cli_help.md.txt
diff --git a/docs/_sources/docs/command_line/fingerprint_reader_cli_help.md.txt b/docs/_sources/docs/command_line/fingerprint_reader_cli_help.md.txt
@@ -1,79 +1,41 @@
 ```text
-
- Usage: mltk fingerprint_reader [OPTIONS] <model>                              
-
- View/save fingerprints captured by the fingerprint eader connected to an      
- embedded device.                                                              
- NOTE: A supported embedded device must be locally connected to use this       
- command.                                                                      
- Additionally, an R503 fingerprint module:                                     
- https://www.adafruit.com/product/4651                                         
- must be connected connected to the development board.                         
- Refer to the online documentation for how to connect it to the development:   
- https://siliconlabs.github.io/mltk/docs/cpp_development/examples/fingerprint_ 
- authenticator.html#hardware-setup                                             
-
- For more details, ee:                                                         
- https://siliconlabs.github.io/mltk/mltk/tutorials/fingerprint_authentication  
-
+
+ Usage: mltk fingerprint_reader [OPTIONS] <model>                                                                                                                                                                                                                                              
+
+ View/save fingerprints captured by the fingerprint eader connected to an embedded device.                                                                                                                                                                                                     
+ NOTE: A supported embedded device must be locally connected to use this command.                                                                                                                                                                                                              
+ Additionally, an R503 fingerprint module: https://www.adafruit.com/product/4651                                                                                                                                                                                                               
+ must be connected connected to the development board.                                                                                                                                                                                                                                         
+ Refer to the online documentation for how to connect it to the development:                                                                                                                                                                                                                   
+ https://siliconlabs.github.io/mltk/docs/cpp_development/examples/fingerprint_authenticator.html#hardware-setup                                                                                                                                                                                
+
+ For more details, ee:                                                                                                                                                                                                                                                                         
+ https://siliconlabs.github.io/mltk/mltk/tutorials/fingerprint_authentication                                                                                                                                                                                                                  
+
  Arguments 
- *    model      <model>  On of the following:                               
-                          - MLTK model name                                  
-                          - Path to .tflite file                             
-                          - Path to model archive file (.mltk.zip)           
-                          NOTE: The model must have been previously trained  
-                          for image classification                           
-                          [default: None]                                    
-                          [required]                                         
+ *    model      <model>  On of the following:                                                       [default: None] [required]                                                                                                                                                              
+                          - MLTK model name                                                                                                                                                                                                                                                  
+                          - Path to .tflite file                                                                                                                                                                                                                                             
+                          - Path to model archive file (.mltk.zip)                                                                                                                                                                                                                           
+                          NOTE: The model must have been previously trained for image classification                                                                                                                                                                                         
 
  Options 
- --accelerator         -a      <name>   Name of accelerator to use while     
-                                        executing the audio classification   
-                                        ML model                             
-                                        [default: None]                      
- --port                        <port>   Serial COM port of a locally         
-                                        connected embedded device.           
-                                        'If omitted, then attempt to         
-                                        automatically determine the serial   
-                                        COM port                             
-                                        [default: None]                      
- --verbose             -v               Enable verbose console logs          
- --generate-dataset    -g               Generate a fingerprint dataset by    
-                                        guiding the user through a sequence  
-                                        of finger captures and saving to the 
-                                        PC.                                  
-                                        NOTE: With this option,              
-                                        --no-inference is automatically      
-                                        enabled                              
- --samples-per-finger  -c      INTEGER  The number of samples per finger to  
-                                        collect when generating the dataset  
-                                        [default: 5]                         
- --dataset-dir                 TEXT     Base directory where dataset should  
-                                        be generated                         
-                                        [default: None]                      
- --dump-images         -d               Dump the raw images from the device  
-                                        fingerprint reader to a directory on 
-                                        the local PC.                        
- --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 
- --app                         <path>   By default, the                      
-                                        fingerprint_authenticator app is     
-                                        automatically downloaded.            
-                                        This option allows for overriding    
-                                        with a custom built app.             
-                                        Alternatively, set this option to    
-                                        "none" to NOT program the            
-                                        fingerprint_authenticator app to the 
-                                        device.                              
-                                        In this case, ONLY the .tflite will  
-                                        be programmed and the existing       
-                                        fingerprint_authenticator app will   
-                                        be re-used.                          
-                                        [default: None]                      
- --test                                 Run as a unit test                   
- --help                                 Show this message and exit.          
+ --accelerator         -a      <name>   Name of accelerator to use while executing the audio classification ML model [default: None]                                                                                                                                                         
+ --port                        <port>   Serial COM port of a locally connected embedded device.                  [default: None]                                                                                                                                                             
+                                        'If omitted, then attempt to automatically determine the serial COM port                                                                                                                                                                             
+ --verbose             -v               Enable verbose console logs                                                                                                                                                                                                                          
+ --generate-dataset    -g               Generate a fingerprint dataset by guiding the user through a sequence of finger captures and saving to the PC.                                                                                                                                       
+                                        NOTE: With this option, --no-inference is automatically enabled                                                                                                                                                                                      
+ --samples-per-finger  -c      INTEGER  The number of samples per finger to collect when generating the dataset [default: 5]                                                                                                                                                                 
+ --dataset-dir                 TEXT     Base directory where dataset should be generated [default: None]                                                                                                                                                                                     
+ --dump-images         -d               Dump the raw images from the device fingerprint reader to a directory on the local PC.                                                                                                                                                               
+ --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                                                                                                           
+ --app                         <path>   By default, the fingerprint_authenticator app is automatically downloaded.                                        [default: None]                                                                                                                    
+                                        This option allows for overriding with a custom built app.                                                                                                                                                                                           
+                                        Alternatively, set this option to "none" to NOT program the fingerprint_authenticator app to the device.                                                                                                                                             
+                                        In this case, ONLY the .tflite will be programmed and the existing fingerprint_authenticator app will be re-used.                                                                                                                                    
+ --test                                 Run as a unit test                                                                                                                                                                                                                                   
+ --help                                 Show this message and exit.                                                                                                                                                                                                                          
 
 
 ```