Skip to content

Commit

Permalink
Documentation - Fix broken links (#1308)
Browse files Browse the repository at this point in the history
* Fix broken links

* remove unused

* restored conf.py

* Update NOTE format

* fix other broken links

* Update README.md

---------

Co-authored-by: Kiriti Gowda <[email protected]>
  • Loading branch information
randyh62 and kiritigowda committed Mar 20, 2024
1 parent 098b7fe commit fc9b957
Show file tree
Hide file tree
Showing 10 changed files with 25 additions and 19 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@ For your convenience, we provide the setup script, `MIVisionX-setup.py`, which i
--backend [MIVisionX Dependency Backend - optional (default:HIP) [options:HIP/OCL/CPU]]
--rocm_path [ROCm Installation Path - optional (default:/opt/rocm ROCm Installation Required)]
```
> [!NOTE]
> * Install ROCm before running the setup script
> * This script only needs to be executed once
Expand All @@ -155,7 +156,7 @@ For your convenience, we provide the setup script, `MIVisionX-setup.py`, which i
git clone https://github.com/ROCm/MIVisionX.git
```
> [!NOTE]
> [!IMPORTANT]
> MIVisionX has support for two GPU backends: **OPENCL** and **HIP**
* Instructions for building MIVisionX with the **HIP** GPU backend (default backend):
Expand Down Expand Up @@ -206,7 +207,7 @@ For your convenience, we provide the setup script, `MIVisionX-setup.py`, which i
macOS [build instructions](https://github.com/ROCm/MIVisionX/wiki/macOS#macos-build-instructions)
> [!IMPORTANT]
> MIVisionX CPU only backend is supported in macOS
> macOS only supports MIVisionX CPU backend
## Verify installation
Expand All @@ -230,8 +231,9 @@ macOS [build instructions](https://github.com/ROCm/MIVisionX/wiki/macOS#macos-bu
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/opt/rocm/lib
runvx /opt/rocm/share/mivisionx/samples/gdf/canny.gdf
```
> [!NOTE]
> * More samples are available [here](samples#samples)
> * More samples are available [here](samples/README.md#samples)
> * For `macOS` use `export DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:/opt/rocm/lib`
#### Verify with mivisionx-test package
Expand All @@ -256,7 +258,7 @@ ctest -VV
MIVisionX provides developers with docker images for Ubuntu `20.04` / `22.04`. Using docker images developers can quickly prototype and build applications without having to be locked into a single system setup or lose valuable time figuring out the dependencies of the underlying software.
Docker files to build MIVisionX containers and suggested workflow are [available](docker#mivisionx-docker)
Docker files to build MIVisionX containers and suggested workflow are [available](docker/README.md#mivisionx-docker)
### MIVisionX docker
* [Ubuntu 20.04](https://cloud.docker.com/repository/docker/mivisionx/ubuntu-20.04)
Expand Down
2 changes: 1 addition & 1 deletion amd_openvx_extensions/amd_migraphx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,6 @@ node com.amd.amd_migraphx_node model image_tensor output_tensor
write output_tensor out_mnist.f32
```

For additional examples for using the `vx_amd_migraphx` extension, please see [amd_migraphx_test](https://github.com/ROCm/MIVisionX/tree/master/tests/amd_migraphx_test/) section.
For additional examples for using the `vx_amd_migraphx` extension, please see [amd_migraphx_tests](https://github.com/ROCm/MIVisionX/tree/master/tests/amd_migraphx_tests/) section.

**NOTE:** OpenVX and the OpenVX logo are trademarks of the Khronos Group Inc.
6 changes: 3 additions & 3 deletions amd_openvx_extensions/amd_winml/samples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Get ONNX models from [ONNX Model Zoo](https://github.com/onnx/models)

## Sample - SqueezeNet

* Download the [SqueezeNet](https://s3.amazonaws.com/download.onnx/models/opset_8/squeezenet.tar.gz) ONNX Model
* Use [Netron](https://lutzroeder.github.io/netron/) to open the model.onnx
* Download the [SqueezeNet](https://github.com/onnx/models/tree/main/validated/vision/classification/squeezenet#squeezenet) ONNX Model
* Use [Netron](https://github.com/lutzroeder/netron) to open the model.onnx
* Look at Model Properties to find Input & Output Tensor Name (data_0 - input; softmaxout_1 - output)
* Look at output tensor dimensions (n,c,h,w - [1,1000,1,1] for softmaxout_1)
* Use the label file - [data\Labels.txt](data/Labels.txt) and sample image - data\car.JPEG to run samples
Expand Down Expand Up @@ -91,7 +91,7 @@ data labelLocation = scalar:STRING,FULL_PATH_TO\data\Labels.txt
## Sample - FER+ Emotion Recognition

* Download the [FER+ Emotion Recognition](https://onnxzoo.blob.core.windows.net/models/opset_8/emotion_ferplus/emotion_ferplus.tar.gz) ONNX Model
* Use [Netron](https://lutzroeder.github.io/netron/) to open the model.onnx
* Use [Netron](https://github.com/lutzroeder/netron) to open the model.onnx
* Look at Model Properties to find Input & Output Tensor Name (Input3 - input; Plus692_Output_0 - output)
* Look at output tensor dimensions (n,c,h,w - [1,8] for Plus692_Output_0)
* Use the label file - [data/emotions.txt](data/emotions.txt) to run sample
Expand Down
2 changes: 1 addition & 1 deletion apps/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
MIVisionX has several applications built on top of OpenVX and its modules, it uses AMD optimized libraries to build applications that can be used as prototypes or used as models to develop products.

## Prerequisites
* [MIVisionX](https://github.com/ROCm/MIVisionX/README.md#build--install-mivisionx) installed
* [MIVisionX](https://github.com/ROCm/MIVisionX/blob/master/README.md#prerequisites) installed

## Bubble Pop

Expand Down
2 changes: 1 addition & 1 deletion apps/dg_test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ See the below section for using your caffemodel.

### Testing with your Caffemodel

You can test your trained MNIST caffemodel using the [model compiler](https://github.com/ROCm/amdovx-modules/tree/develop/utils/model_compiler)
You can test your trained MNIST caffemodel using the [model compiler](https://github.com/ROCm/MIVisionX/tree/master/model_compiler)

1. Convert your caffemodel->NNIR->openvx using the model compiler.
2. From the generated files, copy
Expand Down
7 changes: 5 additions & 2 deletions apps/mivisionx_winml_classifier/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,14 @@ This application is a sample for developing windows application using MIVisionX

## MIVisionX Image Classification

![MIVisionX Image Classification](images/MIVisionX-ImageClassification.png)
![MIVisionX Image Classification](https://raw.githubusercontent.com/ROCm/MIVisionX/master/apps/mivisionx_winml_classifier/images/MIVisionX-ImageClassification.png)


## MIVisionX Image Classification using WinML

![MIVisionX Image Classification using WinML](images/MIVisionX-ImageClassification-WinML.png)
![MIVisionX Image Classification](https://raw.githubusercontent.com/ROCm/MIVisionX/master/apps/mivisionx_winml_classifier/images/MIVisionX-ImageClassification-WinML.png)



Example:

Expand Down
7 changes: 4 additions & 3 deletions docs/doxygen/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -943,8 +943,8 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.

INPUT = ../../README.md \
../../amd_openvx/openvx/include/VX/vx.h \
#INPUT = ../README.md \
INPUT = ../../amd_openvx/openvx/include/VX/vx.h \
../../amd_openvx/openvx/include/VX/vx_api.h \
../../amd_openvx/openvx/include/VX/vx_compatibility.h \
../../amd_openvx/openvx/include/VX/vx_kernels.h \
Expand Down Expand Up @@ -1171,7 +1171,8 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.

USE_MDFILE_AS_MAINPAGE = README.md
#USE_MDFILE_AS_MAINPAGE = README.md
USE_MDFILE_AS_MAINPAGE =

# The Fortran standard specifies that for fixed formatted Fortran code all
# characters from position 72 are to be considered as comment. A common
Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/_toc.yml.in
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Anywhere {branch} is used, the branch name will be substituted.
# These comments will also be removed.
root: doxygen/html/index
root: README
subtrees:
- numbered: False
entries:
Expand Down
2 changes: 1 addition & 1 deletion samples/loom_360_stitch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

MIVisionX samples using [LoomShell](https://github.com/ROCm/MIVisionX/tree/master/utilities/loom_shell#radeon-loomshell)

[![Loom Stitch](https://raw.githubusercontent.com/ROCm/MIVisionX/master/docs/data/loom-4.png)](https://youtu.be/E8pPU04iZjw)
[![Loom Stitch](https://raw.githubusercontent.com/ROCm/MIVisionX/master/docs/data/LOOM_LOGO_250X125.png)](https://youtu.be/E8pPU04iZjw)

**Note:**

Expand Down
4 changes: 2 additions & 2 deletions utilities/runvx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ If available, this project uses OpenCV for camera capture and image display.
Here are few examples that demonstrate use of RUNVX prototyping tool.

### Canny Edge Detector
This example demonstrates building OpenVX graph for Canny edge detector. Use [face1.jpg](https://raw.githubusercontent.com/ROCm/amdovx-core/master/examples/images/face1.jpg) for this example.
This example demonstrates building OpenVX graph for Canny edge detector. Use [face1.jpg](https://raw.githubusercontent.com/ROCm/MIVisionX/master/samples/images/face1.jpg) for this example.

% runvx[.exe] file canny.gdf

Expand All @@ -367,7 +367,7 @@ File **canny.gdf**:
node org.khronos.openvx.canny_edge_detector luma hyst gradient_size !NORM_L1 output

### Skintone Pixel Detector
This example demonstrates building OpenVX graph for pixel-based skin tone detector [Peer et al. 2003]. Use [face1.jpg](https://raw.githubusercontent.com/ROCm/amdovx-core/master/examples/images/face1.jpg) for this example.
This example demonstrates building OpenVX graph for pixel-based skin tone detector [Peer et al. 2003]. Use [face1.jpg](https://raw.githubusercontent.com/ROCm/MIVisionX/master/samples/images/face1.jpg) for this example.

% runvx[.exe] file skintonedetect.gdf

Expand Down

0 comments on commit fc9b957

Please sign in to comment.