Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 8 additions & 8 deletions projects/hipfft/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# hipFFT

hipFFT is an FFT marshalling library that supports
[rocFFT](https://github.com/ROCmSoftwarePlatform/rocFFT) and
[rocFFT](https://github.com/ROCm/rocm-libraries/tree/develop/projects/rocfft) and
[cuFFT](https://developer.nvidia.com/cufft) backends.

hipFFT exports an interface that doesn't require the client to change, regardless of the chosen backend.
Expand All @@ -11,12 +11,12 @@ and marshals results back to your application.
## Documentation

> [!NOTE]
> The published hipFFT documentation is available at [hipFFT](https://rocm.docs.amd.com/projects/hipFFT/en/latest/index.html) in an organized, easy-to-read format, with search and a table of contents. The documentation source files reside in the hipFFT/docs folder of this repository. As with all ROCm projects, the documentation is open source. For more information, see [Contribute to ROCm documentation](https://rocm.docs.amd.com/en/latest/contribute/contributing.html).
> The published hipFFT documentation is available at [hipFFT](https://rocm.docs.amd.com/projects/hipFFT/en/latest/index.html) in an organized, easy-to-read format, with search and a table of contents. The documentation source files reside in the projects/hipfft/docs folder of the rocm-libraries repository. As with all ROCm projects, the documentation is open source. For more information, see [Contribute to ROCm documentation](https://rocm.docs.amd.com/en/latest/contribute/contributing.html).

To build our documentation locally, run the following code:

```bash
cd docs
cd projects/hipfft/docs

pip3 install -r sphinx/requirements.txt

Expand All @@ -36,14 +36,14 @@ To build hipFFT from source, follow these steps:

1. Install the library build dependencies:

* On AMD platforms, you must install [rocFFT](https://github.com/ROCmSoftwarePlatform/rocFFT).
* On AMD platforms, you must install [rocFFT](https://github.com/ROCm/rocm-libraries/tree/develop/projects/rocfft).
* On NVIDIA platforms, you must install [cuFFT](https://developer.nvidia.com/cufft).

2. Install the client build dependencies:

* The clients (samples, tests, etc) included with the hipFFT source depend on hipRAND, FFTW and GoogleTest.

3. Build hipFFT:
3. Build hipFFT. Run these commands from the `rocm-libraries/projects/hipfft` directory:

To show all build options:

Expand Down Expand Up @@ -92,9 +92,9 @@ More information about porting to HIP is available in the

## Support

You can report bugs and feature requests through the GitHub
[issue tracker](https://github.com/ROCm/hipFFT/issues).
You can report bugs and feature requests through the rocm-libraries GitHub
[issue tracker](https://github.com/ROCm/rocm-libraries/issues).

## Contribute

If you want to contribute to hipFFT, you must follow our [contribution guidelines](https://github.com/ROCm/hipFFT/blob/develop/.github/CONTRIBUTING.md).
If you want to contribute to hipFFT, you must follow our [contribution guidelines](https://github.com/ROCm/rocm-libraries/blob/develop/projects/hipfft/.github/CONTRIBUTING.md).
8 changes: 6 additions & 2 deletions projects/hipfft/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@ For more information, see the :ref:`hipfft-overview`.
.. _rocFFT: https://rocm.docs.amd.com/projects/rocFFT/en/latest/index.html
.. _cuFFT: https://developer.nvidia.com/cufft

The hipFFT public repository is located at `<https://github.com/ROCm/hipFFT>`_.
The hipFFT public repository is located at `<https://github.com/ROCm/rocm-libraries/tree/develop/projects/hipfft>`_.

.. note::

The hipFFT repository for ROCm 6.4.3 and earlier is located at `<https://github.com/ROCm/hipFFT>`_.

.. grid:: 2
:gutter: 3
Expand All @@ -32,7 +36,7 @@ The hipFFT public repository is located at `<https://github.com/ROCm/hipFFT>`_.

.. grid-item-card:: Examples

* `hipFFT examples <https://github.com/ROCm/hipFFT/tree/develop/clients/samples>`_
* `hipFFT examples <https://github.com/ROCm/rocm-libraries/tree/develop/projects/hipfft/clients/samples>`_

.. grid-item-card:: API Reference

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ To build hipFFT from source, follow these steps:

#. Build hipFFT:

To show all build options, run these commands:
To show all build options, run these commands from the ``rocm-libraries/projects/hipfft`` directory:

.. code-block:: shell

Expand Down
2 changes: 1 addition & 1 deletion projects/hipfft/docs/sphinx/_toc.yml.in
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ subtrees:

- caption: Examples
entries:
- url: https://github.com/ROCm/hipFFT/tree/develop/clients/samples
- url: https://github.com/ROCm/rocm-libraries/tree/develop/projects/hipfft/clients/samples
title: hipFFT examples

- caption: API reference
Expand Down
16 changes: 8 additions & 8 deletions projects/rocfft/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# rocFFT

rocFFT is a software library for computing fast Fourier transforms (FFTs) written in the HIP
programming language. It's part of AMD's software ecosystem based on
programming language. It's part of the AMD software ecosystem based on
[ROCm](https://github.com/ROCm/ROCm). The rocFFT library can be used with AMD and
NVIDIA GPUs.

## Documentation

> [!NOTE]
> The published rocFFT documentation is available at [rocFFT](https://rocm.docs.amd.com/projects/rocFFT/en/latest/index.html) in an organized, easy-to-read format, with search and a table of contents. The documentation source files reside in the rocFFT/docs folder of this repository. As with all ROCm projects, the documentation is open source. For more information, see [Contribute to ROCm documentation](https://rocm.docs.amd.com/en/latest/contribute/contributing.html).
> The published rocFFT documentation is available at [rocFFT](https://rocm.docs.amd.com/projects/rocFFT/en/latest/index.html) in an organized, easy-to-read format, with search and a table of contents. The documentation source files reside in the projects/rocfft/docs folder of the rocm-libraries repository. As with all ROCm projects, the documentation is open source. For more information, see [Contribute to ROCm documentation](https://rocm.docs.amd.com/en/latest/contribute/contributing.html).

To build our documentation locally, use the following code:

```Bash
cd docs
cd projects/rocfft/docs

pip3 install -r sphinx/requirements.txt

Expand All @@ -36,7 +36,7 @@ You can install rocFFT using pre-built packages or building from source.
* Building from source:

rocFFT is compiled with AMD's clang++ and uses CMake. You can specify several options to customize your
build. The following commands build a shared library for supported AMD GPUs:
build. The following commands build a shared library for supported AMD GPUs. Run these commands from the `rocm-libraries/projects/rocfft` directory:

```bash
mkdir build && cd build
Expand Down Expand Up @@ -81,7 +81,7 @@ You can install rocFFT using pre-built packages or building from source.
sudo apt install libgtest-dev libfftw3-dev libboost-dev
```

We use version 1.11 of GoogleTest.
rocFFT uses version 1.11 of GoogleTest.

You can generate a test coverage report with the following:
```bash
Expand All @@ -99,9 +99,9 @@ You can find additional examples in the `clients/samples` subdirectory.

## Support

You can report bugs and feature requests through the GitHub
[issue tracker](https://github.com/ROCm/rocFFT/issues).
You can report bugs and feature requests through the rocm-libraries GitHub
[issue tracker](https://github.com/ROCm/rocm-libraries/issues).

## Contribute

If you want to contribute to rocFFT, you must follow our [contribution guidelines](https://github.com/ROCm/rocFFT/blob/develop/.github/CONTRIBUTING.md).
If you want to contribute to rocFFT, you must follow the [contribution guidelines](https://github.com/ROCm/rocm-libraries/blob/develop/projects/rocfft/.github/CONTRIBUTING.md).
6 changes: 3 additions & 3 deletions projects/rocfft/docs/how-to/working-with-rocfft.rst
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ You must allocate, initialize, and specify the input/output buffers that hold th
For larger transforms, temporary work buffers might be needed. Because the library tries to minimize its own allocation of
memory regions on the device, it expects you to manage the work buffers. The size of the buffer that is needed can be queried using
:cpp:func:`rocfft_plan_get_work_buffer_size`. After allocation, it can be passed to the library using
:cpp:func:`rocfft_execution_info_set_work_buffer`. The `GitHub repository <https://github.com/ROCm/rocFFT/tree/develop/clients/samples>`_
:cpp:func:`rocfft_execution_info_set_work_buffer`. The `GitHub repository <https://github.com/ROCm/rocm-libraries/tree/develop/projects/rocfft/clients/samples>`_
provide some samples and examples.

Transform and array types
Expand Down Expand Up @@ -316,8 +316,8 @@ reside on a different device and have its own layout parameters.

The rocFFT APIs for declaring fields and bricks are currently experimental and
subject to change in future releases. To submit feedback, questions, and comments
about these interfaces, use the `rocFFT issue tracker
<https://github.com/ROCmSoftwarePlatform/rocFFT/issues>`_.
about these interfaces, use the `rocm-libraries issue tracker
<https://github.com/ROCm/rocm-libraries/issues>`_.

The workflow for using fields is as follows:

Expand Down
8 changes: 6 additions & 2 deletions projects/rocfft/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@ The rocFFT library calculates discrete Fourier transforms for one, two, and thre
supporting various data types for real and complex values.
To learn more, see :doc:`What is rocFFT? <./what-is-rocfft>`

The rocFFT public repository is located at `<https://github.com/ROCm/rocFFT>`_.
The rocFFT public repository is located at `<https://github.com/ROCm/rocm-libraries/tree/develop/projects/rocfft>`_.

.. note::

The rocFFT repository for ROCm 6.4.3 and earlier is located at `<https://github.com/ROCm/rocFFT>`_.

.. grid:: 2
:gutter: 3
Expand All @@ -42,7 +46,7 @@ The rocFFT public repository is located at `<https://github.com/ROCm/rocFFT>`_.

.. grid-item-card:: Samples

* `rocFFT GitHub client examples <https://github.com/ROCm/rocFFT/tree/develop/clients/samples>`_
* `rocFFT GitHub client examples <https://github.com/ROCm/rocm-libraries/tree/develop/projects/rocfft/clients/samples>`_

.. grid-item-card:: API reference

Expand Down
5 changes: 3 additions & 2 deletions projects/rocfft/docs/install/building-installing-rocfft.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ You can use the GitHub releases tab to download the source code. This might prov
than the prebuilt packages.

rocFFT uses the AMD clang++ compiler and CMake. You can specify several options to customize your build.
Use the following commands to build a shared library for the supported AMD GPUs:
Use the following commands to build a shared library for the supported AMD GPUs.
Run these commands from the ``rocm-libraries/projects/rocfft`` directory:

.. code-block:: shell

Expand Down Expand Up @@ -78,7 +79,7 @@ rocFFT uses version 1.11 of GoogleTest.

You can build the clients separately from the main library.
For example, to build all the clients with an existing rocFFT library, invoke CMake from
within the ``rocFFT-src/clients`` folder using these commands:
within the ``rocm-libraries/projects/rocfft/rocFFT-src/clients`` folder using these commands:

.. code-block:: shell

Expand Down
2 changes: 1 addition & 1 deletion projects/rocfft/docs/sphinx/_toc.yml.in
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ subtrees:

- caption: Samples
entries:
- url: https://github.com/ROCm/rocFFT/tree/develop/clients/samples
- url: https://github.com/ROCm/rocm-libraries/tree/develop/projects/rocfft/clients/samples
title: GitHub client examples

- caption: API reference
Expand Down
2 changes: 1 addition & 1 deletion projects/rocfft/docs/what-is-rocfft.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ What is rocFFT?

The rocFFT library implements the discrete Fast Fourier Transform (FFT) in HIP for GPU devices.
It provides a fast and accurate platform for calculating discrete FFTs.
The source code can be found at `<https://github.com/ROCm/rocFFT>`_.
The source code can be found at `<https://github.com/ROCm/rocm-libraries/tree/develop/projects/rocfft>`_.

rocFFT supports the following features:

Expand Down