summarize

Generate a text summary of a model.

Additional Documentation

Usage

                                                                                                                                                                                                                                                                                               
 Usage: yzlite summarize [OPTIONS] <model>                                                                                                                                                                                                                                                       
                                                                                                                                                                                                                                                                                               
 Generate a summary of a model                                                                                                                                                                                                                                                                 
 If a .h5 file is provided or a YZLITE model name/archive/script and *no* --tflite option,                                                                                                                                                                                                       
 then print a summary of the Keras Model.                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                               
 If a .tflite file is provided or a YZLITE model name/archive/script and the --tflite option,                                                                                                                                                                                                    
 then print a summary of the .tflite model.                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                               
 Use the --build option if the model has not been previously trained.                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                               
 For more details see:                                                                                                                                                                                                                                                                         
 https://github.com/ReRAM-Labs/yzlite/docs/guides/model_summary                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                                                                               
 ----------                                                                                                                                                                                                                                                                                    
  Examples                                                                                                                                                                                                                                                                                     
 ----------                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                               
 # Print a summary of pre-trained Keras model                                                                                                                                                                                                                                                  
 yzlite summarize audio_example1                                                                                                                                                                                                                                                                 
                                                                                                                                                                                                                                                                                               
 # Print a summary of pre-trained TF-Lite model                                                                                                                                                                                                                                                
 yzlite summarize audio_example1 --tflite                                                                                                                                                                                                                                                        
                                                                                                                                                                                                                                                                                               
 # Generate a .tflite then print a summary                                                                                                                                                                                                                                                     
 # In this case, the model need not be previously trained                                                                                                                                                                                                                                      
 yzlite summarize audio_example1 --build --tflite                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                               
 # Print of summary of the given .tflite                                                                                                                                                                                                                                                       
 yzlite summarize some/path/my_model.tflite                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                               
 # Print of summary of the given model archive's .tflite                                                                                                                                                                                                                                       
 yzlite summarize some/path/my_model.yzlite.zip --tflite                                                                                                                                                                                                                                           
                                                                                                                                                                                                                                                                                               
 Arguments 
 *    model      <model>  One of the following:                         [default: None] [required]                                                                                                                                                                                           
                          - Path to .tflite model file                                                                                                                                                                                                                                       
                          - Path to .h5 model file                                                                                                                                                                                                                                           
                          - Name of YZLITE model                                                                                                                                                                                                                                               
                          - Path to trained model's archive (.yzlite.zip)                                                                                                                                                                                                                      
                          - Path to YZLITE model's python script                                                                                                                                                                                                                               

 Options 
 --tflite                   Summarize the .tflite model file in the YZLITE model's archive, or if the --build option is given, generate .tflite file before summarizing                                                                                                                        
 --build    -b              Build the model rather than loading from a pre-trained file in the YZLITE model archive                                                                                                                                                                            
 --output   -o      <path>  File path of generated summary file. If omitted, the summary is printed to console [default: None]                                                                                                                                                               
 --verbose  -v              Enable verbose console logs                                                                                                                                                                                                                                      
 --help                     Show this message and exit.