Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc reorganization #1334

Merged
merged 7 commits into from
Apr 23, 2024
Merged

Doc reorganization #1334

merged 7 commits into from
Apr 23, 2024

Conversation

randyh62
Copy link
Contributor

reorganized and created RST doc contents.

@randyh62 randyh62 added docs Need Documentation label ci:docs-only Only run documentation CI on this PR labels Apr 22, 2024
@randyh62 randyh62 requested review from a team, kiritigowda and rrawther as code owners April 22, 2024 21:39
@kiritigowda kiritigowda merged commit b214c31 into ROCm:develop Apr 23, 2024
1 of 4 checks passed
@lpaoletti
Copy link

This looks good.
Did notice that most of the TOC titles don't line up with the actual topic titles.
Especially in here:
image

kiritigowda pushed a commit that referenced this pull request Apr 30, 2024
* doc reorganization

* doc reorg again

* doc reorg more

* doc reorg utilities

* doc reorg utilities

* doc_reorg complete...mostly
MIVisionX documentation
******************************************

AMD MIVisionX toolkit is a comprehensive set of computer vision and machine intelligence libraries, utilities, and applications bundled into a single toolkit. MIVisionX delivers AMD's implementation of `Khronos OpenVX <https://www.khronos.org/openvx/>`_, and a Convolutional Neural Net model compiler & optimizer supporting `ONNX <https://onnx.ai/>`_ and `Khronos NNEF <https://www.khronos.org/nnef>`_ exchange formats. The MIVisionX toolkit allows for rapid prototyping and deployment of optimized computer vision and machine learning inference workloads on a wide range of computer hardware, including small embedded x86 CPUs, APUs, discrete GPUs, and heterogeneous servers. For more information refer to :ref:`what-is-mivisionx`.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add comma:
For more information, refer to

* Refer to `openvx/include/VX <https://github.com/ROCm/MIVisionX/tree/master/amd_openvx/openvx/include>`_ for Khronos OpenVX standard header files.
* Refer to `openvx/include/vx_ext_amd.h <https://github.com/ROCm/MIVisionX/tree/master/amd_openvx/openvx/include/vx_ext_amd.h>`_ for vendor extensions in AMD OpenVX library

Build using `Visual Studio`

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Microsoft Visual Studio with no italics


The following describes installing and setting up the model compiler & optimizer and neural net models for Linux.

Pre-requisites

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no hyphen

yhuiYH pushed a commit that referenced this pull request May 23, 2024
* doc reorganization

* doc reorg again

* doc reorg more

* doc reorg utilities

* doc reorg utilities

* doc_reorg complete...mostly
yhuiYH added a commit that referenced this pull request May 23, 2024
* README - Updates and cleanup

* Readme - Updates (#1299)

* Readme - Updates

* Updates - Readme

* Documentation - Fix broken links (#1308)

* Fix broken links

* remove unused

* restored conf.py

* Update NOTE format

* fix other broken links

* Update README.md

---------

Co-authored-by: Kiriti Gowda <kiriti.nageshgowda@amd.com>

* Docs - update TOC for API Ref (#1327)

* Docs reorganization (#1334)

* doc reorganization

* doc reorg again

* doc reorg more

* doc reorg utilities

* doc reorg utilities

* doc_reorg complete...mostly

* Leo's edits

* Docs - Bump rocm-docs-core[api_reference] from 1.1.1 to 1.1.2 in /docs/sphinx (#1350)

Bumps [rocm-docs-core[api_reference]](https://github.com/RadeonOpenCompute/rocm-docs-core) from 1.1.1 to 1.1.2.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](ROCm/rocm-docs-core@v1.1.1...v1.1.2)

---
updated-dependencies:
- dependency-name: rocm-docs-core[api_reference]
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* fix SoftmaxWithLoss in table

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Kiriti Gowda <kiritigowda@gmail.com>
Co-authored-by: randyh62 <42045079+randyh62@users.noreply.github.com>
Co-authored-by: Kiriti Gowda <kiriti.nageshgowda@amd.com>
Co-authored-by: randyh62 <randyh@amd.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs-only Only run documentation CI on this PR docs Need Documentation label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants