Skip to content

Commit 80385ab

Browse files
docs: comply with mkdocs style (#3378)
refactor(doc): comply with mkdocs style Change from the Autoware.Auto style of package documentation to one that gets parsed better by the current way of generating the documentation. Issue-Id: SCM-5887 Change-Id: I898d00eda921ac73373067036c582a7bbc192cce Signed-off-by: Ambroise Vincent <ambroise.vincent@arm.com> Co-authored-by: Xinyu Wang <93699235+angry-crab@users.noreply.github.com>
1 parent 62e000e commit 80385ab

File tree

5 files changed

+9
-8
lines changed

5 files changed

+9
-8
lines changed

common/tvm_utility/design/tvm-utility-design.md common/tvm_utility/README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
# TVM Utility {#tvm-utility-design}
1+
# TVM Utility
22

33
This is the design document for the `tvm_utility` package. For instructions on how to build the tests for YOLOv2 Tiny,
4-
see the @subpage tvm-utility-yolo-v2-tiny-tests. For information about where to store test artifacts see the @subpage tvm-utility-artifacts-readme.
4+
see the [YOLOv2 Tiny Example Pipeline](tvm-utility-yolo-v2-tiny-tests.md).
5+
For information about where to store test artifacts see the [TVM Utility Artifacts](artifacts/README.md).
56

67
## Purpose / Use cases
78

@@ -17,7 +18,7 @@ provided.
1718
### API
1819

1920
The pre-processor and post-processor need to be implemented by the user before instantiating the pipeline. You can see example
20-
usage in this [example_pipeline](../test/yolo_v2_tiny).
21+
usage in the example pipeline at `test/yolo_v2_tiny`.
2122

2223
Each stage in the pipeline has a `schedule` function which takes input data as a parameter and return the output data.
2324
Once the pipeline object is created, `pipeline.schedule` is called to run the pipeline.

common/tvm_utility/artifacts/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# TVM Utility Artifacts {#tvm-utility-artifacts-readme}
1+
# TVM Utility Artifacts
22

33
Place any test artifacts in subdirectories within this directory.
44

common/tvm_utility/design/tvm-utility-yolo-v2-tiny-tests.md common/tvm_utility/tvm-utility-yolo-v2-tiny-tests.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# YOLOv2 Tiny Example Pipeline {#tvm-utility-yolo-v2-tiny-tests}
1+
# YOLOv2 Tiny Example Pipeline
22

33
This is an example implementation of an inference pipeline using the pipeline
44
framework. This example pipeline executes the

perception/lidar_apollo_segmentation_tvm/design/lidar-segmentation-design.md perception/lidar_apollo_segmentation_tvm/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# lidar_apollo_segmentation_tvm {#lidar-apollo-segmentation-tvm-design}
1+
# lidar_apollo_segmentation_tvm
22

33
## Design
44

5-
### Usage {#lidar-apollo-segmentation-tvm-design-usage}
5+
### Usage
66

77
#### Neural network
88

perception/lidar_apollo_segmentation_tvm_nodes/design/lidar-segmentation-nodes-design.md perception/lidar_apollo_segmentation_tvm_nodes/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# lidar_apollo_segmentation_tvm_nodes {#lidar-apollo-segmentation-tvm-nodes-design}
1+
# lidar_apollo_segmentation_tvm_nodes
22

33
## Purpose / Use cases
44

0 commit comments

Comments
 (0)