From c1eb1947ea14945b5bb29270090de50f8ffa78a3 Mon Sep 17 00:00:00 2001 From: JunYuLiu Date: Sat, 19 Sep 2020 16:51:07 +0800 Subject: [PATCH] Fix the link for markdown --- docs/note/source_en/design.rst | 1 + .../note/source_en/design/mindspore/mindir.md | 8 ++-- docs/note/source_en/specification_note.rst | 6 ++- docs/note/source_zh_cn/specification_note.rst | 2 + tutorials/lite/source_en/convert_model.rst | 8 ++++ tutorials/lite/source_en/index.rst | 6 ++- .../use/post_training_quantization.md | 3 ++ tutorials/lite/source_zh_cn/convert_model.rst | 4 +- tutorials/lite/source_zh_cn/index.rst | 8 ++-- .../training/source_en/advanced_use/cv.rst | 2 +- .../source_en/advanced_use/migrate_script.rst | 9 +++++ .../training/source_en/advanced_use/nlp.rst | 2 +- tutorials/training/source_en/index.rst | 37 ++++++------------- .../source_en/use/data_preparation.rst | 2 +- .../source_en/use/defining_the_network.rst | 4 +- 15 files changed, 59 insertions(+), 43 deletions(-) create mode 100644 tutorials/lite/source_en/convert_model.rst create mode 100644 tutorials/lite/source_en/use/post_training_quantization.md create mode 100644 tutorials/training/source_en/advanced_use/migrate_script.rst diff --git a/docs/note/source_en/design.rst b/docs/note/source_en/design.rst index 47a8c3c104..f828e869c1 100644 --- a/docs/note/source_en/design.rst +++ b/docs/note/source_en/design.rst @@ -11,5 +11,6 @@ Design design/mindinsight/training_visual_design design/mindinsight/graph_visual_design design/mindinsight/tensor_visual_design + design/mindinsight/profiler_design design/mindarmour/differential_privacy_design design/mindarmour/fuzzer_design diff --git a/docs/note/source_en/design/mindspore/mindir.md b/docs/note/source_en/design/mindspore/mindir.md index c480fd8454..8dc2cf5b6c 100644 --- a/docs/note/source_en/design/mindspore/mindir.md +++ b/docs/note/source_en/design/mindspore/mindir.md @@ -77,7 +77,7 @@ lambda (x, y) let c = b * %1 in c end ``` -The corresponding MindIR is [ir.dot](./images/ir/ir.dot). +The corresponding MindIR is [ir.dot](https://gitee.com/mindspore/docs/blob/r1.0/docs/note/source_en/design/mindspore/images/ir/ir.dot). ![](./images/ir/ir.png) @@ -107,7 +107,7 @@ def hof(x): return res ``` -The corresponding MindIR is [hof.dot](./images/ir/hof.dot). +The corresponding MindIR is [hof.dot](https://gitee.com/mindspore/docs/blob/r1.0/docs/note/source_en/design/mindspore/images/ir/hof.dot). ![](./images/ir/hof.png) In the actual network training scripts, the automatic derivation generic function `GradOperation` and `Partial` and `HyperMap` that are commonly used in the optimizer are typical high-order functions. Higher-order semantics greatly improve the flexibility and simplicity of MindSpore representations. @@ -127,7 +127,7 @@ def fibonacci(n): return fibonacci(n-1) + fibonacci(n-2) ``` -The corresponding MindIR is [cf.dot](./images/ir/cf.dot). +The corresponding MindIR is [cf.dot](https://gitee.com/mindspore/docs/blob/r1.0/docs/note/source_en/design/mindspore/images/ir/cf.dot). ![](./images/ir/cf.png) `fibonacci` is a top-level function graph. Two function graphs at the top level are selected and called by `switch`. `✓fibonacci` is the True branch of the first `if`, and `✗fibonacci` is the False branch of the first `if`. `✓✗fibonacci` called in `✗fibonacci` is the True branch of `elif`, and `✗✗fibonacci` is the False branch of `elif`. The key is, in a MindIR, conditional jumps and recursion are represented in the form of higher-order control flows. For example, `✓✗fibonacci` and `✗fibonacci` are transferred in as parameters of the `switch` operator. `switch` selects a function as the return value based on the condition parameter. In this way, `switch` performs a binary selection operation on the input functions as common values and does not call the functions. The real function call is completed on CNode following `switch`. @@ -152,7 +152,7 @@ def ms_closure(): return out1, out2 ``` -The corresponding MindIR is [closure.dot](./images/ir/closure.dot). +The corresponding MindIR is [closure.dot](https://gitee.com/mindspore/docs/blob/r1.0/docs/note/source_en/design/mindspore/images/ir/closure.dot). ![](./images/ir/closure.png) In the example, `a` and `b` are free variables because the variables `a` and `b` in `func_inner` are parameters defined in the referenced parent graph `func_outer`. The variable `closure` is a closure, which is the combination of the function `func_inner` and its context `func_outer(1, 2)`. Therefore, the result of `out1` is 4, which is equivalent to `1+2+1`, and the result of `out2` is 5, which is equivalent to `1+2+2`. diff --git a/docs/note/source_en/specification_note.rst b/docs/note/source_en/specification_note.rst index 66b021a446..bd2b83eebf 100644 --- a/docs/note/source_en/specification_note.rst +++ b/docs/note/source_en/specification_note.rst @@ -1,5 +1,5 @@ -规格说明 -=========== +Specification Note +================== .. toctree:: :maxdepth: 1 @@ -8,4 +8,6 @@ network_list operator_list constraints_on_network_construction + image_classification + object_detection diff --git a/docs/note/source_zh_cn/specification_note.rst b/docs/note/source_zh_cn/specification_note.rst index 66b021a446..566271cc24 100644 --- a/docs/note/source_zh_cn/specification_note.rst +++ b/docs/note/source_zh_cn/specification_note.rst @@ -8,4 +8,6 @@ network_list operator_list constraints_on_network_construction + image_classification + object_detection diff --git a/tutorials/lite/source_en/convert_model.rst b/tutorials/lite/source_en/convert_model.rst new file mode 100644 index 0000000000..2ad9e964c8 --- /dev/null +++ b/tutorials/lite/source_en/convert_model.rst @@ -0,0 +1,8 @@ +Convert Into The MindSpore Lite Model +===================================== + +.. toctree:: + :maxdepth: 1 + + use/converter_tool + use/post_training_quantization \ No newline at end of file diff --git a/tutorials/lite/source_en/index.rst b/tutorials/lite/source_en/index.rst index 5ddc42f053..29aeffccf8 100644 --- a/tutorials/lite/source_en/index.rst +++ b/tutorials/lite/source_en/index.rst @@ -4,7 +4,7 @@ contain the root `toctree` directive. Using MindSpore on Mobile and IoT -======================== +================================= .. toctree:: :glob: @@ -19,7 +19,9 @@ Using MindSpore on Mobile and IoT :caption: Basic Use use/build - use/converter_tool + convert_model use/evaluating_the_model use/image_processing use/runtime + use/benchmark_tool + use/timeprofiler_tool diff --git a/tutorials/lite/source_en/use/post_training_quantization.md b/tutorials/lite/source_en/use/post_training_quantization.md new file mode 100644 index 0000000000..128543f399 --- /dev/null +++ b/tutorials/lite/source_en/use/post_training_quantization.md @@ -0,0 +1,3 @@ +# Note + +Post training quantization is being translated, will be released soon. \ No newline at end of file diff --git a/tutorials/lite/source_zh_cn/convert_model.rst b/tutorials/lite/source_zh_cn/convert_model.rst index 7a6e093242..841271ef7a 100644 --- a/tutorials/lite/source_zh_cn/convert_model.rst +++ b/tutorials/lite/source_zh_cn/convert_model.rst @@ -4,5 +4,5 @@ .. toctree:: :maxdepth: 1 - converter_tool - post_training_quantization \ No newline at end of file + use/converter_tool + use/post_training_quantization \ No newline at end of file diff --git a/tutorials/lite/source_zh_cn/index.rst b/tutorials/lite/source_zh_cn/index.rst index e79b691eb8..3acc0a9493 100644 --- a/tutorials/lite/source_zh_cn/index.rst +++ b/tutorials/lite/source_zh_cn/index.rst @@ -4,7 +4,7 @@ contain the root `toctree` directive. 在手机或IoT设备上使用MindSpore -================== +============================= .. toctree:: :glob: @@ -19,7 +19,9 @@ :caption: 基础使用 use/build - use/converter_model + convert_model use/evaluating_the_model use/image_processing - use/runtime \ No newline at end of file + use/runtime + use/benchmark_tool + use/timeprofiler_tool \ No newline at end of file diff --git a/tutorials/training/source_en/advanced_use/cv.rst b/tutorials/training/source_en/advanced_use/cv.rst index 868eaec5c6..6805f048e9 100644 --- a/tutorials/training/source_en/advanced_use/cv.rst +++ b/tutorials/training/source_en/advanced_use/cv.rst @@ -1,5 +1,5 @@ Computer Vision -=========== +=============== .. toctree:: :maxdepth: 1 diff --git a/tutorials/training/source_en/advanced_use/migrate_script.rst b/tutorials/training/source_en/advanced_use/migrate_script.rst new file mode 100644 index 0000000000..43e600d7a0 --- /dev/null +++ b/tutorials/training/source_en/advanced_use/migrate_script.rst @@ -0,0 +1,9 @@ +Migrate Training Scripts of Third Party Frameworks +================================================== + +.. toctree:: + :maxdepth: 1 + + migrate_3rd_scripts_mindconverter + migrate_3rd_scripts + \ No newline at end of file diff --git a/tutorials/training/source_en/advanced_use/nlp.rst b/tutorials/training/source_en/advanced_use/nlp.rst index 1f501ac032..8461f17afa 100644 --- a/tutorials/training/source_en/advanced_use/nlp.rst +++ b/tutorials/training/source_en/advanced_use/nlp.rst @@ -1,5 +1,5 @@ Natural Language Processing -=========== +=========================== .. toctree:: :maxdepth: 1 diff --git a/tutorials/training/source_en/index.rst b/tutorials/training/source_en/index.rst index 5e0530dc3c..36d86c37de 100644 --- a/tutorials/training/source_en/index.rst +++ b/tutorials/training/source_en/index.rst @@ -4,7 +4,7 @@ contain the root `toctree` directive. Train with MindSpore -=================== +==================== .. toctree:: :glob: @@ -19,7 +19,7 @@ Train with MindSpore :maxdepth: 1 :caption: Basic Use - use/data_preparation/data_preparation + use/data_preparation use/defining_the_network use/save_and_load_model @@ -28,15 +28,13 @@ Train with MindSpore :maxdepth: 1 :caption: Process Data - advanced_use/converse_dataset - advanced_use/enable_cache advanced_use/optimize_data_processing .. toctree:: :glob: :maxdepth: 1 - :caption: + :caption: Build Networks advanced_use/custom_operator advanced_use/migrate_script @@ -46,9 +44,10 @@ Train with MindSpore :maxdepth: 1 :caption: Model Optimization - advanced_use/debugging_in_pynative_mode - advanced_use/customized_debugging_information + advanced_use/debug_in_pynative_mode + advanced_use/custom_debugging_info advanced_use/visualization_tutorials + advanced_use/synchronization_training_and_evaluation.md .. toctree:: :glob: @@ -56,19 +55,10 @@ Train with MindSpore :caption: Performance Optimization advanced_use/distributed_training_tutorials - advanced_use/mixed_precision - advanced_use/graph_kernel_fusion - advanced_use/quantization_aware - advanced_use/gradient_accumulation - -.. toctree:: - :glob: - :maxdepth: 1 - :caption: Network Migration - - advanced_use/network_migration - advanced_use/migrate_3rd_scripts_mindconverter - + advanced_use/enable_mixed_precision + advanced_use/enable_graph_kernel_fusion + advanced_use/apply_quantization_aware_training + advanced_use/apply_gradient_accumulation .. toctree:: :glob: @@ -84,8 +74,5 @@ Train with MindSpore :maxdepth: 1 :caption: Application - advanced_use/computer_vision_application - advanced_use/nlp_application - advanced_use/synchronization_training_and_evaluation.md - advanced_use/optimize_the_performance_of_data_preparation.md - + advanced_use/cv + advanced_use/nlp \ No newline at end of file diff --git a/tutorials/training/source_en/use/data_preparation.rst b/tutorials/training/source_en/use/data_preparation.rst index 9a9fc3d1a4..c871b6bc89 100644 --- a/tutorials/training/source_en/use/data_preparation.rst +++ b/tutorials/training/source_en/use/data_preparation.rst @@ -1,5 +1,5 @@ Load Dataset -======== +============ .. toctree:: :maxdepth: 1 diff --git a/tutorials/training/source_en/use/defining_the_network.rst b/tutorials/training/source_en/use/defining_the_network.rst index a530f34dbd..71dc64a136 100644 --- a/tutorials/training/source_en/use/defining_the_network.rst +++ b/tutorials/training/source_en/use/defining_the_network.rst @@ -4,5 +4,5 @@ Defining the Network .. toctree:: :maxdepth: 1 - Network List - custom_operator \ No newline at end of file + Network List + \ No newline at end of file -- Gitee