Command Line Usage
# vaitrace --help
usage: vaitrace [-h] [-c [CONFIG]] [-d] [-o [TRACESAVETO]] [-t [TIMEOUT]] [-v]
[-b] [-p] [--va] [--xat] [--txt_summary] [--fine_grained]
...
positional arguments:
cmd
optional arguments:
-h, --help show this help message and exit
-c [CONFIG] Specify the config file
-d Enable debug
-o [TRACESAVETO] Save report to, only available for txt summary mode
-t [TIMEOUT] Tracing time limitation
-v Show version
-b Bypass vaitrace, just run command
-p Trace python application
--va Generate trace data for Vitis Analyzer
--xat Save raw data for debug usage
--txt_summary Display txt summary
--fine_grained Fine-grained mode
Following are some important and frequently used arguments:
- cmd
- cmd is an executable Vitis AI program that traces, including the program name and arguments.
- -t
- Controlling the tracing time (in seconds) starting from the [cmd] being launched, the default value is 30. In other words, if no -t is specified for vaitrace, the tracing stops after [cmd] runs for 30 seconds. The [cmd] continues running normally but stops collecting tracing data.
- -c
- You can start a tracing with more custom options by writing these options on a JSON configuration file and specifying the configuration by -c. Details of the configuration file are explained in the next section.
- -o
- Location of the report. This is only available for the text summary mode. By default, the test summary outputs to STDOUT.
- --va
- Generate trace data for Vitis Analyzer, enabled by default, cannot work together with --txt_summary.
- --txt_summary or --txt
- Output text summary. vaitrace does not generate a report for the Vitis Analyzer in this mode and cannot work together with --va.
- --fine_grained
- Start trace in the fine-grained mode. This mode generates a mass of trace data, limiting the trace time to 10 seconds.
Other arguments are used for debugging.