aboutsummaryrefslogtreecommitdiff
path: root/OPTIONS.md
diff options
context:
space:
mode:
authorJacob Bohlin <jacob.bohlin@arm.com>2020-06-17 09:19:21 +0200
committerTim Hall <tim.hall@arm.com>2020-06-18 17:53:52 +0100
commite4fd48078f1f3e840ddda1a78d483547760f2287 (patch)
tree123fb7494fa7cdb899d0c7a27b60aae77cf8cfa5 /OPTIONS.md
parent2a7ebe3045d766c7abdb3bca49e90f3f9afb8664 (diff)
downloadethos-u-vela-e4fd48078f1f3e840ddda1a78d483547760f2287.tar.gz
doc: Remove remains of a merge-conflict in OPTIONS.md1.0.0
Signed-off-by: Jacob Bohlin <jacob.bohlin@arm.com> Change-Id: Id6dc0aac1b8b493d65c9c8ea132f5c4b5e273654
Diffstat (limited to 'OPTIONS.md')
-rw-r--r--OPTIONS.md69
1 files changed, 3 insertions, 66 deletions
diff --git a/OPTIONS.md b/OPTIONS.md
index 20fcd542..fa060bbe 100644
--- a/OPTIONS.md
+++ b/OPTIONS.md
@@ -1,66 +1,8 @@
# Vela Options
-<<<<<<< HEAD
-This document contains a description of all of the Command Line Interface (CLI) options. It also contains a definition and description of the System Configuration file format.
-
-## CLI Options
-
-### Compulsory (Positional) Arguments
-
-|Option Name|Value|Default Value|Description|
-|-|-|-|-|
-|NETWORK|POSIX pathname|-|Filename of the .tflite model to compile.|
-
-### Optional Arguments
-
-|Option Name|Value|Default Value|Description|
-|-|-|-|-|
-|-h, --help|-|-|Show the help message and exit.|
-|--version|-|-|Show program's version number and exit.|
-|--output-dir \<Value>|POSIX pathname|./output|Output directory to write the output files to. The output files are an optimised version of the input model with a `_vela.tflite` file prefix, along with the performance estimate (EXPERIMENTAL) CSV files).|
-|--accelerator-config \<Value>|ethos-u55-256, ethos-u55-128, <br/>ethos-u55-64, or ethos-u55-32|ethos-u55-256|Accelerator configuration to use.|
-|--block-config-limit \<Value>|Positive integer|16|Limits the block config search space, use zero for unlimited.|
-|--cascading \<Value>|True or False|True|Controls the packing of multiple passes into a cascade.|
-|--config \<Value>|POSIX pathname|-|Specify a [Vela system configuration file](#system-configuration-file) to read.|
-|--dram-bandwidth \<Value>|Floating point|0.0|DRAM memory bandwidth in GB/s, use zero to select the value from system config.|
-|--force-block-config \<Value>|HxWxC where H,W and C are integers|-|Force a specific block configuration.|
-|--global-memory-clock-scale \<Value>|Floating point|1.0|Performs an additional scaling of the individual memory clock scales specified by the system config.|
-|--ifm-ofm-overlap \<Value>|True or False|True|Controls the overlapping of IFM and OFM buffers.|
-|--ifm-streaming \<Value>|True or False|True|Controls scheduler IFM streaming search.|
-|--inter-pass-cycle-delay \<Value>|Integer|0|Artificial delay between passes, measured in NPU cycles.|
-|--max-block-dependency \<Value>|0 to 3 inclusive|3|Set the maximum value that can be used for the block dependency between npu kernel operations.|
-|--pareto-metric \<Value>|BwCycMem or BwCycMemBlkH|BwCycMem|Controls the calculation of the pareto metric.|
-|--permanent-storage \<Value>|OnChipFlash or OffChipFlash|OffChipFlash|Memory area for permanent storage. To store the weights and other constant data in SRAM select 'OnChipFlash'.|
-|--recursion-limit \<Value>|Positive integer|10000|Set the recursion depth limit, may result in RecursionError if too low.|
-|--system-config \<Value>|String|internal-default|System configuration to use.|
-|--tensor-allocator \<Value>|LinearAlloc or Greedy|Greedy|Tensor Allocator algorithm.|
-|--timing|-|Disabled|Enable the timing of the compiler's operations|
-|--verbose-allocation|-|-|Verbose tensor allocation|
-|--verbose-graph|-|-|Verbose graph rewriter|
-|--verbose-high-level-command-stream|-|-|Verbose high level command stream|
-|--verbose-operators|-|-|Verbose operator list|
-|--verbose-packing|-|-|Verbose pass packing|
-|--verbose-pareto-frontier-schedules|-|-|Show all schedules along the pareto frontier of optimisation criteria|
-|--verbose-quantization|-|-|Verbose quantization|
-|--verbose-register-command-stream|-|-|Verbose register command stream|
-|--verbose-schedule|-|-|Verbose schedule|
-|--verbose-tensor-format|-|-|Verbose tensor format|
-|--verbose-tensor-purpose|-|-|Verbose tensor purpose|
-|--show-cpu-operations|-|-|Show the operations that fall back to the CPU|
-|--show-minimum-possible-allocation|-|-|Show the minimum possible allocation|
-|--show-subgraph-io-summary|-|-|Shows a summary of all the subgraphs and their inputs and outputs|
-
-## System Configuration File
-
-This is used to describe various properties of the embedded system that the network will run in.
-
-Example of a Vela system configuration file.
-
-```
-=======
This file contains a more verbose and detailed description of the Vela
Compiler's CLI options than the built-in help strings. It also defines and
-describes the Vela config file format.
+describes the Vela system configuration file format.
## Command Line Interface
@@ -255,8 +197,8 @@ vela network.tflite --global-memory-clock-scale 1.5
### Pareto Metric
Controls the calculation of the pareto metric. Use 'BwCycMemBlkH' to consider
-block height on top of Bandwidth, Cycle count and Memory. This can reduce SRAM
-usage in some circumstances.
+Block Height in addition to Bandwidth, Cycle count and Memory. This can reduce
+SRAM usage in some circumstances.
**Type: String**
**Default: BwCycMem**
**Choices: [BwCycMem, BwCycMemBlkH]**
@@ -436,7 +378,6 @@ vela network.tflite --config sys_cfg_vela.ini --system-config MySysConfig
Example of a Vela system configuration file.
```ini
->>>>>>> beabcd8... MLBEDSW-2061: Document CLI Options
; File: sys_cfg_vela.ini
; The file contains two parts; a system config part and a CPU operator
; performance part.
@@ -478,8 +419,4 @@ default.slope=1.0
MyCpu.intercept=0.0
MyCpu.slope=1.0
-<<<<<<< HEAD
-```
-=======
```
->>>>>>> beabcd8... MLBEDSW-2061: Document CLI Options