The long-awaited update to the ROCm™ platform documentation site is here. AMD is excited to announce the new ROCm Docs site is live at ROCm.docs.AMD.com, and we invite you to explore and experience the new user-friendly pages.
Our phase 1 delivery of ROCm Docs site is designed to be better in just about every way, including:
- Improved user experience and search
- New docs as Code (DaC) model
- Known issue tracking and new issue submission portal
- Updated and new content
Improved User Experience
ROCm Docs is now more user friendly than ever before, featuring an easy-to-follow side navigation bar which prominently shows which version of ROCm documentation you are viewing. Now users can always be sure they are navigating through documentation for their installed version of the ROCm platform. This also applies to the new integrated search capabilities, which allows users to search exact words or code snippets within a certain version of ROCm platform so returned results are specific to the version you are running.
Installation instructions have also been improved by condensing the content and adding tabs at the top for each operating system, which allows users to easily toggle to the version for their OS. Both GPU and OS support statements have been refreshed and are now grouped by AMD GPU family for easy navigation.
ROCm docs now has links to other useful resources, including the new GitHub Community, AMD Lab Notes blogs, and the GitHub support portal. The site also features a convenient light and dark mode setting so users can customize the look and feel to their preference.
Docs –as Code (DaC)
We are glad to announce that AMD adopted a Docs as Code (DaC) model for our ROCm documentation, allowing ROCm platform developers, whether from within AMD or as part of the larger ROCm community, to contribute, add, revise or correct documentation with the same familiar tools and processes they use when developing code. DaC allows us to control the ROCm documentation versions using git tools, resulting in the ROCm documentation being in close alignment with the actual ROCm code repository.
We hope that moving the ROCm documentation to DaC will encourage members of the ROCm community to participate and contribute directly to our documentation effort, requesting changes, reporting issues and revising and adding new content. We believe that engaging with the ROCm platform community is core to our future success, and DaC will help us translate our vision to practice.
Issue Tracking
ROCm is now tracking defects, issues, errata, bug reports through GitHub. We are also encouraging new documentation issue submission via GitHub. Users can submit their issues and receive a quick response from the ROCm platform team at AMD. Issues are tracked on GitHub by the ROCm version using GitHub labels. You can filter issues for a particular ROCm platform release on GitHub. (Full roll out of this functionality will be complete in the coming weeks.)
Content Updates
Along with the update to the ROCm documentation site and browsing experience , there are also many new pieces of documentation that now exist in ROCm Docs, including documentation on Composable Kernel and hipBLASlt. Release notes have also been updated to clearly show whether components have changed from release to release. Other new content covers topics such as using Docker with ROCm, GPU isolation techniques, and an updated article on how to use CMake with ROCm.
Coming Soon
There are still more exciting updates to come to ROCm Docs in the near future. Diátaxis ( Diátaxis (diataxis.fr)) - A systematic framework for technical documentation authoring – will be formally adopted as the structural foundation to ROCm documentation. Improved and expanded content is in the works. Our attention to documentation is unwavering and focused to let you make the most from ROCm.
So, what are you waiting for? Visit the new ROCm Docs site and experience all the great features for yourself. Make sure to stop back by the blog in the coming weeks as we will be highlighting more enhancements to ROCm Docs that will help you along your developer journey.
Making the ROCm platform even easier to adopt
For ROCm users and developers, AMD is continually looking for ways to make ROCm easier to use, easier to deploy on systems and to provide learning tools and technical documents to support those efforts.
Helpful Resources:
- The ROCm web pages provide an overview of the platform and what it includes, along with HPC & AI markets and workloads it supports.
- ROCm Information Portal is a portal for users and developers that posts the latest ROCm versions along with API and support documentation. This portal also hosts ROCm learning materials to help introduce the ROCm platform to new users, as well as to provide existing users with curated videos, webinars, labs, and tutorials to help in developing and deploying systems on the platform.
- AMD Infinity Hub gives you details on ROCm supported HPC applications and ML frameworks, and how to get the latest versions and install documents. You can also access the ROCm Application Catalog there, which includes an up-to-date listing of ROCm enabled applications.
- Finally, learn more about our AMD Instinct™ MI200 Series family of accelerators and partner server solutions in our AMD Instinct Server Solutions Catalog.
Sydney Freeman is Sr. Product Marketing Specialist for AMD. Her postings are her own opinions and may not represent AMD’s positions, strategies or opinions. Links to third party sites are provided for convenience and unless explicitly stated, AMD is not responsible for the contents of such linked sites and no endorsement is implied.
