structured home page,outline

RadeonOpenCompute · Jul 12, 2017 · 6c23938 · 6c23938
1 parent f4254cf
commit 6c23938
Show file tree

Hide file tree

Showing 16 changed files with 341 additions and 34 deletions.
diff --git a/Current_Release_Notes/Current-Release-Notes.rst b/Current_Release_Notes/Current-Release-Notes.rst
@@ -0,0 +1,36 @@
+
+.. _Current-Release-Notes:
+
+=====================
+Current Release Notes
+=====================
+
+ROCm 1.6 What New?
+###################
+
+    *  2.0 compatible kernel language support with OpenCL 1.2 compatible runtime
+    * OpenCL compiler also has assembler and disassembler support, inline assembly support.
+    * Big improvements in the base Native LLVM code generator with new large number of optimization.
+    * HCC Compiler Upgrade with New Gid Dispatch foundation
+    * HIP new APIs: hipMemcpy2DAsync, hipMallocPitch, hipHostMallocCoherent, hipHostMallocNonCoherent
+    * New Low Level Performance Library Interface
+    * ARM AArch64 and IBM Power 8 support in the core driver
+    * MIOpen 1.0 Deep Learning Solver
+    * Debian and Yum Package for Math Libraries ( rocBLAS, rocFFT, hcFFT, hcRNG, hcBLAS, hibBLAS)
+    * ROCm-SMI update to check current Power Utilization of GPU
+    * Radeon Compute Profiler Formally called the ROCm Profiler
+    * New Package Server repo.radeon.com to give you better download performance
+
+
+
+Quick Start Guide
+==================
+
+
+Installation Guide Ubuntu
+=========================
+
+Installation Guide Fedora
+==========================
+
+
diff --git a/GCN_ISA_Manuals/GCN-ISA-Manuals.rst b/GCN_ISA_Manuals/GCN-ISA-Manuals.rst
@@ -0,0 +1,15 @@
+
+.. _GCN-ISA-Manuals:
+
+=====================
+GCN ISA Manuals
+=====================
+
+GCN 1.1
+========
+
+GCN 2.0
+========
+
+Inline GCN ISA Assembly Guide
+==============================
diff --git a/HSA.jpeg b/HSA.jpeg
diff --git a/Installation_Guide/Installation-Guide.rst b/Installation_Guide/Installation-Guide.rst
@@ -0,0 +1,13 @@
+
+.. _Installation-Guide:
+
+===================
+Installation Guide
+===================
+
+
+Installation Guide Ubuntu
+==========================
+
+Installation Guide Fedora
+==========================
diff --git a/Other_Solutions/Other-Solutions.rst b/Other_Solutions/Other-Solutions.rst
@@ -0,0 +1,10 @@
+
+.. _Other-Solutions:
+
+================
+Other Solutions
+================
+
+
+ROCr Error Codes
+================
diff --git a/Programming_Guides/Programming-Guides.rst b/Programming_Guides/Programming-Guides.rst
@@ -0,0 +1,37 @@
+.. _Programming-Guides:
+
+=================
+Programing Guide
+=================
+
+
+HC Programing Guide
+===================
+
+HC Best Practices
+=================
+
+
+HIP Programing Guide
+====================
+
+
+
+HIP Best Practices
+==================
+
+
+
+OpenCL Programing Guide
+========================
+
+
+
+
+OpenCL Best Practices
+======================
+
+
+
+
+
diff --git a/ROCm_API_References/ROCm-API-References.rst b/ROCm_API_References/ROCm-API-References.rst
@@ -0,0 +1,37 @@
+
+.. _ROCm-API-References:
+
+=====================
+Rocm API References
+=====================
+
+
+ROCr System Runtime API
+=======================
+
+HCC Language Runtime API
+========================
+
+HIP Language Runtime API
+========================
+
+HIP Device Runtime API
+======================
+
+HIP Math API
+====================
+
+Math Libarary API's
+====================
+
+Deep Learning API's
+====================
+
+
+
+
+
+
+
+
+
diff --git a/ROCm_Compiler_SDK/ROCm-Compiler-SDK.rst b/ROCm_Compiler_SDK/ROCm-Compiler-SDK.rst
@@ -0,0 +1,20 @@
+
+.. _ROCm-Compiler-SDK:
+
+=====================
+ROCm Compiler SDK
+=====================
+
+GCN Native ISA LLVM Code Generator
+===================================
+
+ROCm Code Object Format
+=======================
+
+ROC Device Library
+=====================
+
+ROCr Runtime
+=====================
+
+
diff --git a/ROCm_GPU_Tunning_Guides/ROCm-GPU-Tunning-Guides.rst b/ROCm_GPU_Tunning_Guides/ROCm-GPU-Tunning-Guides.rst
@@ -0,0 +1,13 @@
+
+.. _ROCm-GPU-Tunning-Guides:
+
+========================
+ROCm GPU Tunning Guides
+========================
+
+
+GFX7 Tuning Guide
+=================
+
+GFX8 Tuning Guide
+=================
diff --git a/ROCm_Glossary/ROCm-Glossary.rst b/ROCm_Glossary/ROCm-Glossary.rst
@@ -0,0 +1,12 @@
+
+.. _ROCm-Glossary:
+
+================
+ROCm Glossary
+================
+
+
+
+
+
+
diff --git a/ROCm_Stack.png b/ROCm_Stack.png
diff --git a/ROCm_System_Managment/ROCm-System-Managment.rst b/ROCm_System_Managment/ROCm-System-Managment.rst
@@ -0,0 +1,17 @@
+
+.. _ROCm-System-Management:
+
+=======================
+ROCm System Management
+=======================
+
+
+
+ROCm-SMI
+=================
+
+Programing ROCm-SMI
+===================
+
+SYSFS Interface
+=================
diff --git a/ROCm_Tools/ROCm-Tools.rst b/ROCm_Tools/ROCm-Tools.rst
@@ -0,0 +1,37 @@
+
+.. _ROCm-Tools:
+
+=====================
+ROCm Tools
+=====================
+
+
+HCC
+=====
+
+GCN Assembler and Disassembler
+==============================
+
+GCN Assembler Tools
+====================
+
+ROCm-GDB
+==========
+
+ROCm Debugger API
+=================
+
+ROCm-Profiler
+==============
+
+CodeXL
+=========
+
+GPUperfAPI
+==============
+
+ROCm Binary Utilities
+======================
+
+
+
diff --git a/ROCm_Virtualization_Containers/ROCm-Virtualization-&-Containers.rst b/ROCm_Virtualization_Containers/ROCm-Virtualization-&-Containers.rst
@@ -0,0 +1,17 @@
+
+.. _ROCm-Virtualization-&-Containers:
+
+=================================
+ROCm Virtualization & Containers
+=================================
+
+KVM Passthrough
+================
+
+ROCm-Docker
+===========
+
+
+
+
+
diff --git a/Remote_Device_Programming/Remote-Device-Programming.rst b/Remote_Device_Programming/Remote-Device-Programming.rst
@@ -0,0 +1,19 @@
+
+.. _Remote-Device-Programming:
+
+==========================
+Remote Device Programming
+==========================
+
+
+ROCnRDMA
+=========
+
+UCX
+====
+
+MPI
+=====
+
+IPC
+====
diff --git a/index.rst b/index.rst
@@ -1,45 +1,69 @@
+ .. rocm documentation master file, created by
+   sphinx-quickstart on Tue Jul 11 20:12:28 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
 
-ROCm Documentation (Update in Progress)
-***************************************
+Welcome to ROCm Platform
+=========================
 
-
-Welcome to ROCm
-===============
-.. _ROCm website: http://radeonopencompute.github.io
+We are excited to present ROCm, the first open-source HPC/Hyperscale-class platform for GPU computing that’s also programming-language independent. We are bringing the UNIX philosophy of choice, minimalism and modular software development to GPU computing. The new ROCm foundation lets you choose or even develop tools and a language run time for your application.
 
-* If you're interested in trying ROCm out, check out the .
+**ROCm is built for scale**; it supports multi-GPU computing in and out of server-node communication through RDMA. It also simplifies the stack when the driver directly incorporates RDMA peer-sync support.
 
-* If you want to help develop ROCm, please have a look at 
-  and get in touch !
+**ROCm has a rich system run time** with the critical features that large-scale application, compiler and language-run-time development requires.
 
-All of the documentation and source code is available under the MIT license,
-unless otherwise specified. Consult .
+**HSA Compliant Runtime and Driver for AMD RADEON GPU’s**
+  .. image:: HSA.jpeg
+      :width: 200px
+      :height: 100px
 
+Going to 11: Amping Up the Programming-Language Run-Time Foundation
+####################################################################
+The ROCr System Runtime is language independent and makes heavy use of the Heterogeneous System Architecture (HSA) Runtime API. This approach provides a rich foundation to exectute programming languages such as HCC C++ and HIP, the Khronos Group’s OpenCL, and Continum’s Anaconda Python.
 
-.. toctree::
-   :maxdepth: 2
+.. image:: ROCm_stack.png
+    :width: 200px
+    :height: 100px
+
+Important features include the following:
+
+    * Multi-GPU coarse-grain shared virtual memory
+    * Process concurrency and preemption
+    * Large memory allocations
+    * HSA signals and atomics
+    * User-mode queues and DMA
+    * Standardized loader and code-object format
+    * Dynamics and offline-compilation support
+    * Peer-to-peer multi-GPU operation with RDMA support
+    * Profiler trace and event-collection API
+    * Systems-management API and tools
+
+Solid Compilation Foundation and Language Support
+####################################################
+    * LLVM compiler foundation
+    * HCC C++ and HIP for application portability
+    * GCN assembler and disassembler
 
-   testing
-   =======
+The frontiers of what you can accomplish with ROCm are vast and uncharted. We look forward to working with you to improve the platform so you can use it more effectively in your own projects. Our efforts have opened the door to unique heterogeneous-computing applications that explore what this growing technology can do.
+
+.. toctree::
+   :maxdepth: 6
+   :hidden:
 
-   Release/notes
-   Installation/Guide
-   Programming/Guide
-   ROCm/GPU/Tuning/Guide
-   GCN/ISA/Manuals
-   ROCm/API/References 
-   ROCm/Tools
-   ROCm/Compiler/SDK
-   ROCm/System/Managment
-   ROCm/Virtualization/&/Containers
-   Remote/Device/Programing
-   Other/Solutions
-   ROCm/Glossary 
-   LICENSE
+
+   Current_Release_Notes/Current-Release-Notes
+   Installation_Guide/Installation-Guide
+   Programming_Guides/Programming-Guides
+   ROCm_GPU_Tunning_Guides/ROCm-GPU-Tunning-Guides
+   GCN_ISA_Manuals/GCN-ISA-Manuals
+   ROCm_API_References/ROCm-API-References
+   ROCm_Tools/ROCm-Tools
+   ROCm_Compiler_SDK/ROCm-Compiler-SDK
+   ROCm_System_Managment/ROCm-System-Managment
+   ROCm_Virtualization_Containers/ROCm-Virtualization-&-Containers
+   Remote_Device_Programming/Remote-Device-Programming
+   Other_Solutions/Other-Solutions
+   ROCm_Glossary/ROCm-Glossary
+
 
 
-Indices and tables
-==================
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`