Skip to content

Commit

Permalink
PR feedbacks
Browse files Browse the repository at this point in the history
  • Loading branch information
neon60 committed Sep 10, 2024
1 parent 95a3d85 commit bd17afb
Show file tree
Hide file tree
Showing 29 changed files with 62 additions and 39 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. meta::
:description: This chapter is the global enum and defines reference page
:description: The global enum and defines reference page.
:keywords: AMD, ROCm, HIP, CUDA, global enum, defines

.. _global_enum_defines_reference:
Expand Down
4 changes: 3 additions & 1 deletion docs/reference/hip_runtime_api/modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,11 @@ The API is organized into modules based on functionality:
* :ref:`memory_management_reference`

* :ref:`external_resource_interoperability_reference`
* :ref:`stream_memory_operations_reference`
* :ref:`stream_ordered_memory_allocator_reference`
* :ref:`unified_memory_reference`
* :ref:`virtual_memory_reference`
* :ref:`texture_management_reference`
* :ref:`texture_management_deprecated_reference`

* :ref:`peer_to_peer_device_memory_access_reference`
* :ref:`context_management_reference`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. meta::
:description: This chapter is the callback activity APIs reference page.
:description: The callback activity APIs reference page.
:keywords: AMD, ROCm, HIP, CUDA, callback activity APIs, callback activity

.. _callback_activity_apis_reference:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. meta::
:description: This chapter is the context management reference page.
:description: The context management reference page.
:keywords: AMD, ROCm, HIP, CUDA, context management, context

.. _context_management_reference:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
.. meta::
:description: This chapter lists types and device API wrappers related to the Cooperative Group feature. Programmers can directly use these API features in their kernels.
:description: This chapter lists types and device API wrappers related to the
Cooperative Group feature. Programmers can directly use these
API features in their kernels.
:keywords: AMD, ROCm, HIP, cooperative groups

.. _cooperative_groups_reference:

*******************************************************************************
Cooperative groups API
Cooperative groups
*******************************************************************************

Cooperative kernel launches
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. meta::
:description: This chapter is the device management reference page
:description: The device management reference page.
:keywords: AMD, ROCm, HIP, CUDA, device management, device

.. _device_management_reference:
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/hip_runtime_api/modules/error_handling.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. meta::
:description: This chapter is the error handling reference page
:description: The error handling reference page.
:keywords: AMD, ROCm, HIP, CUDA, error handling, error

.. _error_handling_reference:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. meta::
:description: This chapter is the event management reference page
:description: The event management reference page.
:keywords: AMD, ROCm, HIP, CUDA, event management, event

.. _event_management_reference:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. meta::
:description: This chapter is the execution control reference page
:description: The execution control reference page.
:keywords: AMD, ROCm, HIP, CUDA, execution control, execution

.. _execution_control_reference:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. meta::
:description: This chapter is the graph management reference page.
:description: The graph management reference page.
:keywords: AMD, ROCm, HIP, CUDA, graph management, graph

.. _graph_management_reference:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. meta::
:description: This chapter is the initialization and version reference page
:description: The initialization and version reference page.
:keywords: AMD, ROCm, HIP, CUDA, initialization, version

.. _driver_reference:
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/hip_runtime_api/modules/launch_api.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. meta::
:description: This chapter is the launch API to support the triple-chevron
syntax reference page.
:description: The launch API to support the triple-chevron syntax reference
page.
:keywords: AMD, ROCm, HIP, CUDA, launch API, triple-chevron

.. _launch_api_reference:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. meta::
:description: This chapter is the memory management reference page
:description: The memory management reference page.
:keywords: AMD, ROCm, HIP, CUDA, memory management, memory

.. _memory_management_reference:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
.. meta::
:description: This chapter is the external resource interoperability reference
page.
:description: The external resource interoperability reference page.
:keywords: AMD, ROCm, HIP, CUDA, external resource interoperability

.. _external_resource_interoperability_reference:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. meta::
:description: The stream ordered memory allocator reference page.
:keywords: AMD, ROCm, HIP, CUDA, stream ordered memory allocator

.. _stream_ordered_memory_allocator_reference:

*******************************************************************************
Stream ordered memory allocator
*******************************************************************************

.. doxygengroup:: StreamO
:content-only:
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. meta::
:description: This chapter is the surface object reference page.
:description: The surface object reference page.
:keywords: AMD, ROCm, HIP, CUDA, surface object, surface

.. _surface_object_reference:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. meta::
:description: This chapter is the texture management reference page.
:description: The texture management reference page.
:keywords: AMD, ROCm, HIP, CUDA, texture management, texture

.. _texture_management_reference:
Expand All @@ -10,6 +10,3 @@ Texture management

.. doxygengroup:: Texture
:content-only:

.. doxygengroup:: TextureD
:content-only:
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. meta::
:description: The deprecated texture management reference page.
:keywords: AMD, ROCm, HIP, CUDA, deprecated texture management

.. _texture_management_deprecated_reference:

*******************************************************************************
Texture management (deprecated)
*******************************************************************************

.. doxygengroup:: TextureD
:content-only:
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
.. meta::
:description: This chapter describes introduces Unified Memory (UM) and shows
how to use it in AMD HIP.
:description: The managed memory management reference page.
:keywords: AMD, ROCm, HIP, CUDA, unified memory, unified, memory, UM, APU

.. _unified_memory_reference:

*******************************************************************************
Managed memory allocation API
Managed memory management
*******************************************************************************

.. doxygengroup:: MemoryM
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
.. _virtual_memory_reference:

*******************************************************************************
Virtual memory management API
Virtual memory management
*******************************************************************************

.. doxygengroup:: Virtual
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. meta::
:description: This chapter is the module management reference page.
:description: The module management reference page.
:keywords: AMD, ROCm, HIP, CUDA, module management, module

.. _module_management_reference:
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/hip_runtime_api/modules/occupancy.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. meta::
:description: This chapter is the occupancy reference page.
:description: The occupancy reference page.
:keywords: AMD, ROCm, HIP, CUDA, occupancy

.. _occupancy_reference:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. meta::
:description: This chapter is the OpenGL interoperability reference page.
:description: The OpenGL interoperability reference page.
:keywords: AMD, ROCm, HIP, CUDA, OpenGL interoperability, OpenGL interop

.. _opengl_interoperability_reference:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
.. meta::
:description: This chapter is the peer to peer device memory access reference
page.
:description: The peer to peer device memory access reference page.
:keywords: AMD, ROCm, HIP, CUDA, peer to peer device memory access, peer to peer

.. _peer_to_peer_device_memory_access_reference:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. meta::
:description: This chapter is the profiler control reference page.
:description: The profiler control reference page.
:keywords: AMD, ROCm, HIP, CUDA, profiler control, profiler

.. _profiler_control_reference:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. meta::
:description: This chapter is the runtime compilation reference page.
:description: The runtime compilation reference page.
:keywords: AMD, ROCm, HIP, CUDA, runtime compilation

.. _runtime_compilation_reference:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. meta::
:description: This chapter is the stream management reference page
:description: The stream management reference page.
:keywords: AMD, ROCm, HIP, CUDA, stream management, stream

.. _stream_management_reference:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. meta::
:description: This chapter is the stream memory operations reference page
:description: The stream memory operations reference page.
:keywords: AMD, ROCm, HIP, CUDA, stream memory operations

.. _stream_memory_operations_reference:
Expand Down
9 changes: 5 additions & 4 deletions docs/sphinx/_toc.yml.in
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ subtrees:
- file: reference/hip_runtime_api/modules
subtrees:
- entries:
- file: reference/hip_runtime_api/modules/global_enum_and_defines
- file: reference/hip_runtime_api/modules/initialization_and_version
- file: reference/hip_runtime_api/modules/device_management
- file: reference/hip_runtime_api/modules/execution_control
Expand All @@ -54,22 +53,24 @@ subtrees:
subtrees:
- entries:
- file: reference/hip_runtime_api/modules/memory_management/external_resource_interoperability
- file: reference/hip_runtime_api/modules/memory_management/stream_memory_operations
- file: reference/hip_runtime_api/modules/memory_management/stream_ordered_memory_allocator
- file: reference/hip_runtime_api/modules/memory_management/unified_memory_reference
- file: reference/hip_runtime_api/modules/memory_management/virtual_memory_reference
- file: reference/hip_runtime_api/modules/memory_management/texture_management
- file: reference/hip_runtime_api/modules/memory_management/texture_management_deprecated
- file: reference/hip_runtime_api/modules/memory_management/surface_object
- file: reference/hip_runtime_api/modules/peer_to_peer_device_memory_access
- file: reference/hip_runtime_api/modules/context_management
- file: reference/hip_runtime_api/modules/module_management
- file: reference/hip_runtime_api/modules/occupancy
- file: reference/hip_runtime_api/modules/profiler_control
- file: reference/hip_runtime_api/modules/launch_api
- file: reference/hip_runtime_api/modules/texture_management
- file: reference/hip_runtime_api/modules/surface_object
- file: reference/hip_runtime_api/modules/runtime_compilation
- file: reference/hip_runtime_api/modules/callback_activity_apis
- file: reference/hip_runtime_api/modules/graph_management
- file: reference/hip_runtime_api/modules/opengl_interoperability
- file: reference/hip_runtime_api/modules/cooperative_groups_reference
- file: reference/hip_runtime_api/global_enum_and_defines
- file: doxygen/html/annotated_data_structures
- file: doxygen/html/files_files
- file: reference/virtual_rocr
Expand Down

0 comments on commit bd17afb

Please sign in to comment.