derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
130 lines
11 KiB
Markdown
130 lines
11 KiB
Markdown
# ROCm Libraries
|
|
|
|
Welcome to the ROCm Libraries super-repo. This repository consolidates multiple ROCm-related libraries and shared components into a single repository to streamline development, CI, and integration.
|
|
|
|
## Super-repo Goals
|
|
|
|
- Enable unified build and test workflows across ROCm libraries.
|
|
- Facilitate shared tooling, CI, and contributor experience.
|
|
- Improve integration, visibility, and collaboration across ROCm library teams.
|
|
|
|
## Super-repo Project Status
|
|
|
|
### TheRock CI Status
|
|
|
|
TheRock CI performs multi-component testing on top of builds leveraging [TheRock](https://github.com/ROCm/TheRock) build system.
|
|
|
|
[](https://github.com/ROCm/rocm-libraries/actions/workflows/therock-ci.yml?query=branch%3Adevelop+event%3Apush) [](https://github.com/ROCm/rocm-libraries/actions/workflows/therock-ci-nightly.yml?query=branch%3Adevelop)
|
|
|
|
### Component Migration and Legacy CI Status
|
|
|
|
This table provides the current status of the migration of specific components as well as a pointer to the health of their legacy CI systems.
|
|
|
|
**Key:**
|
|
- **Completed**: Fully migrated and integrated. This super-repo should be considered the source of truth for this project. The old repo may still be used for certain release activities.
|
|
- **In Progress**: Ongoing migration, tests, or integration. Please refrain from submitting new pull requests on the individual repo of the project, and develop on the super-repo.
|
|
- **Pending**: Not yet started or in the early planning stages. The individual repo should be considered the source of truth for this project.
|
|
|
|
| Component | Migration Status | Math CI Status |
|
|
|---------------------|------------------|---------------------------------------|
|
|
| `composablekernel` | Completed | |
|
|
| `hipblas` | Completed | [](http://math-ci.amd.com/job/rocm-libraries/job/precheckin/job/hipblas/job/develop/lastBuild/) |
|
|
| `hipblas-common` | Completed | [](http://math-ci.amd.com/job/rocm-libraries/job/precheckin/job/hipblas-common/job/develop/lastBuild/) |
|
|
| `hipblaslt` | Completed | [](http://math-ci.amd.com/job/rocm-libraries/job/precheckin/job/hipblaslt/job/develop/lastBuild/) [](http://math-ci.amd.com/job/rocm-libraries/job/preliminary/job/hipblaslt/job/develop/lastBuild/)|
|
|
| `hipcub` | Completed | [](http://math-ci.amd.com/job/rocm-libraries/job/precheckin/job/hipcub/job/develop/lastBuild/) |
|
|
| `hipfft` | Completed | [](http://math-ci.amd.com/job/rocm-libraries/job/precheckin/job/hipfft/job/develop/lastBuild/) |
|
|
| `hiprand` | Completed | [](http://math-ci.amd.com/job/rocm-libraries/job/precheckin/job/hiprand/job/develop/lastBuild/) |
|
|
| `hipsolver` | Completed | [](http://math-ci.amd.com/job/rocm-libraries/job/precheckin/job/hipsolver/job/develop/lastBuild/) |
|
|
| `hipsparse` | Completed | [](http://math-ci.amd.com/job/rocm-libraries/job/precheckin/job/hipsparse/job/develop/lastBuild/) |
|
|
| `hipsparselt` | Completed | [](http://math-ci.amd.com/job/rocm-libraries/job/precheckin/job/hipsparselt/job/develop/lastBuild/) |
|
|
| `miopen` | Completed | [](http://micimaster.amd.com/job/rocm-libraries-folder/job/MIOpen/job/develop/lastBuild/) |
|
|
| `mxdatagenerator` | Completed | [](http://math-ci.amd.com/job/rocm-libraries/job/precheckin/job/mxdatagenerator/job/develop/lastBuild/) |
|
|
| `origami` | Completed |[](http://math-ci.amd.com/job/rocm-libraries/job/precheckin/job/origami/job/develop/lastBuild/) |
|
|
| `rocblas` | Completed | [](http://math-ci.amd.com/job/rocm-libraries/job/precheckin/job/rocblas/job/develop/lastBuild/) |
|
|
| `rocfft` | Completed | [](http://math-ci.amd.com/job/rocm-libraries/job/precheckin/job/rocfft/job/develop/lastBuild/) |
|
|
| `rocprim` | Completed | [](http://math-ci.amd.com/job/rocm-libraries/job/precheckin/job/rocprim/job/develop/lastBuild/) |
|
|
| `rocrand` | Completed | [](http://math-ci.amd.com/job/rocm-libraries/job/precheckin/job/rocrand/job/develop/lastBuild/) |
|
|
| `rocsolver` | Completed | [](http://math-ci.amd.com/job/rocm-libraries/job/precheckin/job/rocsolver/job/develop/lastBuild/) |
|
|
| `rocsparse` | Completed | [](http://math-ci.amd.com/job/rocm-libraries/job/precheckin/job/rocsparse/job/develop/lastBuild/) |
|
|
| `rocthrust` | Completed | [](http://math-ci.amd.com/job/rocm-libraries/job/precheckin/job/rocthrust/job/develop/lastBuild/) |
|
|
| `rocroller` | Completed |[](http://math-ci.amd.com/job/rocm-libraries/job/precheckin/job/rocroller/job/develop/lastBuild/) |
|
|
| `tensile` | Completed | [](http://math-ci.amd.com/job/rocm-libraries/job/precheckin/job/tensile/job/develop/lastBuild/) |
|
|
| `rocwmma` | Completed | [](http://math-ci.amd.com/job/rocm-libraries/job/precheckin/job/rocwmma/job/develop/lastBuild/) |
|
|
| `hiptensor` | Completed | [](http://math-ci.amd.com/job/rocm-libraries/job/precheckin/job/hiptensor/job/develop/lastBuild/) |
|
|
|
|
## Nomenclature
|
|
|
|
Project names have been standardized to match the casing and punctuation of released packages. This removes inconsistent camel-casing and underscores used in legacy repositories.
|
|
|
|
## Structure
|
|
|
|
The repository is organized as follows:
|
|
|
|
```
|
|
projects/
|
|
composablekernel/
|
|
hipblas/
|
|
hipblas-common/
|
|
hipblaslt/
|
|
hipcub/
|
|
hipdnn/
|
|
hipfft/
|
|
hiprand/
|
|
hipsolver/
|
|
hipsparse/
|
|
hipsparselt/
|
|
hiptensor/
|
|
miopen/
|
|
rocblas/
|
|
rocfft/
|
|
rocprim/
|
|
rocrand/
|
|
rocsolver/
|
|
rocsparse/
|
|
rocthrust/
|
|
rocwmma/
|
|
shared/
|
|
rocroller/
|
|
tensile/
|
|
mxdatagenerator/
|
|
origami/
|
|
```
|
|
|
|
- Each folder under `projects/` corresponds to a ROCm library that was previously maintained in a standalone GitHub repository and released as distinct packages.
|
|
- Each folder under `shared/` contains code that existed in its own repository and is used as a dependency by multiple libraries, but does not produce its own distinct packages in previous ROCm releases.
|
|
|
|
## Getting Started
|
|
|
|
To begin contributing or building, see the [CONTRIBUTING.md](./CONTRIBUTING.md) guide. It includes setup instructions, sparse-checkout configuration, development workflow, and pull request guidelines.
|
|
|
|
## License
|
|
|
|
This super-repo contains multiple subprojects, each of which retains the license under which it was originally published.
|
|
|
|
- 📁 Refer to the `LICENSE`, `LICENSE.md`, or `LICENSE.txt` file within each `projects/` or `shared/` directory for specific license terms.
|
|
- 📄 Refer to the header notice in individual files outside `projects/` or `shared/` folders for their specific license terms.
|
|
|
|
> [!NOTE]
|
|
> The root of this repository does not yet define a unified license across all components.
|
|
|
|
## Questions or Feedback?
|
|
|
|
- 💬 [Start a discussion](https://github.com/ROCm/rocm-libraries/discussions)
|
|
- 🐞 [Open an issue](https://github.com/ROCm/rocm-libraries/issues)
|
|
|
|
We're happy to help!
|
|
|
|
### Filing an issue
|
|
|
|
When you open an issue in the rocm-libraries repo, please help us help you by being as clear and
|
|
reproducible as possible. Before creating a new issue, please search existing ones to avoid duplicates.
|
|
For bug reports, include a minimal reproducible example (or small test case) that triggers the error,
|
|
along with full environment details (ROCm version, GPU, compiler, OS, etc.). If relevant, try to reduce
|
|
the problem (e.g., smaller code snippet) to make diagnosis easier. Finally, if you have ideas for how
|
|
to fix or improve something, feel free to suggest them — maintainers appreciate actionable feedback.
|
|
|
|
Be sure to check out the [hipblaslt runtime error triage checklist](./docs/hipblaslt-runtime-triage-checklist.md)
|
|
for a detailed step-by-step process for identifying and reporting runtime errors so we have all of the
|
|
information necessary to help resolve the issue quickly. While this checklist is specific to hipblaslt
|
|
the same process is generally applicable to other rocm-libraries components.
|