Skip to content

Commit

Permalink
docs: comply with mkdocs style (#3378)
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
ambroise-arm and angry-crab authored Apr 17, 2023
1 parent 62e000e commit 80385ab
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 8 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# TVM Utility {#tvm-utility-design}
# TVM Utility

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

## Purpose / Use cases

Expand All @@ -17,7 +18,7 @@ provided.
### API

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

Each stage in the pipeline has a `schedule` function which takes input data as a parameter and return the output data.
Once the pipeline object is created, `pipeline.schedule` is called to run the pipeline.
Expand Down
2 changes: 1 addition & 1 deletion common/tvm_utility/artifacts/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# TVM Utility Artifacts {#tvm-utility-artifacts-readme}
# TVM Utility Artifacts

Place any test artifacts in subdirectories within this directory.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# YOLOv2 Tiny Example Pipeline {#tvm-utility-yolo-v2-tiny-tests}
# YOLOv2 Tiny Example Pipeline

This is an example implementation of an inference pipeline using the pipeline
framework. This example pipeline executes the
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# lidar_apollo_segmentation_tvm {#lidar-apollo-segmentation-tvm-design}
# lidar_apollo_segmentation_tvm

## Design

### Usage {#lidar-apollo-segmentation-tvm-design-usage}
### Usage

#### Neural network

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# lidar_apollo_segmentation_tvm_nodes {#lidar-apollo-segmentation-tvm-nodes-design}
# lidar_apollo_segmentation_tvm_nodes

## Purpose / Use cases

Expand Down

0 comments on commit 80385ab

Please sign in to comment.