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.

Sign up for GitHub

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

Jump to bottom

Docs - Fix a few erroneous links to the examples directory #187

Merged
merged 1 commit into from
Aug 2, 2024
Merged

Docs - Fix a few erroneous links to the examples directory #187

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/how-to/framework.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ Follow these steps:
train_label_one_hot_list = get_label_one_hot(train_label_ndArray)


4. To see and run a sample training script, refer to `rocAL TensorFlow example <https://github.com/ROCm/rocAL/tree/master/rocAL/docs/examples/tf/pets_training>`_.
4. To see and run a sample training script, refer to `rocAL TensorFlow example <https://github.com/ROCm/rocAL/tree/master/docs/examples/tf/pets_training>`_.

.. __resnet50:

Expand Down
2 changes: 1 addition & 1 deletion docs/how-to/overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,4 +109,4 @@ Decoders Description
====================== ========================================

To see examples demonstrating the usage of decoders and readers, see
`rocAL Python Examples <https://github.com/ROCm/rocAL/tree/master/rocAL/docs/examples>`_.
`rocAL Python Examples <https://github.com/ROCm/rocAL/tree/master/docs/examples>`_.
2 changes: 1 addition & 1 deletion docs/user_guide/ch1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
To optimize the preprocessing pipeline, rocAL utilizes the following features:

- Prefetching: Loads the data for the next batch while the existing batch is under process. This parallelization allows more batches to be processed in less time.
- Hybrid execution: Utilizes both the CPU and GPU simultaneously. For example, decoding the data on the CPU while running the training on the GPU. 

Check failure on line 14 in docs/user_guide/ch1.md

View workflow job for this annotation

GitHub Actions / Documentation / Markdown

Trailing spaces 

docs/user_guide/ch1.md:14:147 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.28.2/doc/md009.md
- Hardware decoding: Uses the AMD VCN and VA-API to efficiently decode data on the hardware. 
- Batch processing: Groups and processes the data together as a batch.

Expand Down Expand Up @@ -80,4 +80,4 @@
| Image_random_crop | Decodes and randomly crops JPEG images |
| Image_slice | Decodes and slices JPEG images |

To see examples demonstrating the usage of decoders and readers, [click here](https://github.com/ROCm/rocAL/tree/master/rocAL/docs/examples)
To see examples demonstrating the usage of decoders and readers, [click here](https://github.com/ROCm/rocAL/tree/master/docs/examples)
Loading