From e112b7c2955cfe739994e683cdc5392658341769 Mon Sep 17 00:00:00 2001 From: liutuo Date: Wed, 11 Jul 2018 15:55:33 +0800 Subject: [PATCH] update docs --- docs/user_guide/advanced_usage.rst | 22 +++++++++++----------- docs/user_guide/op_lists.rst | 7 +++---- 2 files changed, 14 insertions(+), 15 deletions(-) diff --git a/docs/user_guide/advanced_usage.rst b/docs/user_guide/advanced_usage.rst index cbd8c3cc..2cdca66e 100644 --- a/docs/user_guide/advanced_usage.rst +++ b/docs/user_guide/advanced_usage.rst @@ -1,19 +1,19 @@ -============== +=============== Advanced usage -============== +=============== This part contains the full usage of MACE. -========= +--------- Overview -========= +--------- As mentioned in the previous part, a model deployment file defines a case of model deployment. The whole building process is loading a deployment file, converting models, building MACE and packing generated files. -================ +---------------- Deployment file -================ +---------------- One deployment file will generate one library normally, but if more than one ABIs are specified, @@ -24,7 +24,7 @@ in one deployment file. * **Example** - Here is an example deployment file used by an Android demo application. + Here is an example deployment file with two models. .. literalinclude:: models/demo_app_models.yml :language: yaml @@ -105,9 +105,9 @@ in one deployment file. sha256sum /path/to/your/file -============== +--------------- Advanced Usage -============== +--------------- There are two common advanced use cases: 1. convert a model to CPP code. 2. tuning for specific SOC if use GPU. @@ -274,9 +274,9 @@ There are two common advanced use cases: 1. convert a model to CPP code. 2. tuni // ... Same with the code in basic usage. -=============== +---------------- Useful Commands -=============== +---------------- * **run the model** .. code:: sh diff --git a/docs/user_guide/op_lists.rst b/docs/user_guide/op_lists.rst index 4df013c2..7bff5f32 100644 --- a/docs/user_guide/op_lists.rst +++ b/docs/user_guide/op_lists.rst @@ -3,7 +3,6 @@ Operator lists .. Please keep in chronological order when editing .. csv-table:: - :widths: auto :header: "Operator","Supported","Remark" "AVERAGE_POOL_2D","Y","" @@ -27,17 +26,17 @@ Operator lists "LOCAL_RESPONSE_NORMALIZATION","Y","" "LOGISTIC","Y","" "LSTM","","" - "MATMUL","Y","" + "MATMUL","Y","Only CPU is supported" "MAX_POOL_2D","Y","" "PAD","Y","" "PSROI_ALIGN","Y","" "PRELU","Y","Only caffe model is supported" - "REDUCE_MEAN","Y","Only tensorflow model is supported" + "REDUCE_MEAN","Y","Only tensorflow model is supported. For GPU only H + W axis reduce is supported" "RELU","Y","" "RELU1","Y","" "RELU6","Y","" "RELUX","Y","" - "RESHAPE","Y","Limited support: only internal use of reshape in composed operations is supported" + "RESHAPE","Y","Limited support: GPU is full supported, for CPU only supports softmax-like usage" "RESIZE_BILINEAR","Y","" "RNN","","" "RPN_PROPOSAL_LAYER","Y","" -- GitLab