Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Spellcheck and minor docs updates #361

Merged
merged 4 commits into from
Jul 10, 2023
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ set(HIPSPARSE_CONFIG_DIR "\${CPACK_PACKAGING_INSTALL_PREFIX}/${CMAKE_INSTALL_LIB

rocm_create_package(
NAME ${package_name}
DESCRIPTION "Radeon Open Compute SPARSE library"
DESCRIPTION "ROCm SPARSE library"
MAINTAINER "hipSPARSE Maintainer <hipsparse-maintainer@amd.com>"
LDCONFIG
LDCONFIG_DIR ${HIPSPARSE_CONFIG_DIR})
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
```

## Installing pre-built packages
Download pre-built packages either from [ROCm's package servers](https://rocm.github.io/install.html#installing-from-amd-rocm-repositories) or by clicking the github releases tab and manually downloading, which could be newer. Release notes are available for each release on the releases tab.
Download pre-built packages either from [ROCm's package servers](https://rocm.docs.amd.com/en/latest/deploy/linux/index.html). Release notes are available for each release on the releases tab on GitHub.
* `sudo apt update && sudo apt install hipsparse`

## Quickstart hipSPARSE build
Expand Down
2 changes: 1 addition & 1 deletion clients/include/testing_csx2dense.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ hipsparseStatus_t testing_csx2dense(const Arguments& argus, FUNC1& csx2dense, FU
verify_hipsparse_status(status,
expected_status,
(expected_status == HIPSPARSE_STATUS_SUCCESS)
? "Error: call with zero sizes must be succesfull."
? "Error: call with zero sizes must be successful."
: "Error: An invalid size must be detected.");

return HIPSPARSE_STATUS_SUCCESS;
Expand Down
2 changes: 1 addition & 1 deletion clients/include/testing_dense2csx.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ hipsparseStatus_t testing_dense2csx(const Arguments& argus, FUNC& dense2csx)
verify_hipsparse_status(status,
expected_status,
(expected_status == HIPSPARSE_STATUS_SUCCESS)
? "Error: call with zero sizes must be succesfull."
? "Error: call with zero sizes must be successful."
: "Error: An invalid size must be detected.");

return HIPSPARSE_STATUS_SUCCESS;
Expand Down
2 changes: 1 addition & 1 deletion deps/external-gtest.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ else( )
else( )
set( gtest_make "make" )

# The -j paramter does not work with nmake
# The -j parameter does not work with nmake
if( NOT Cores EQUAL 0 )
math( EXPR Cores "${Cores} + 1 " )
list( APPEND gtest_make -j ${Cores} )
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
hipSPARSE Documentation
#######################

hipSPARSE exposes a common interface that provides Basic Linear Algebra Subroutines for sparse computation implemented on top of AMD's Radeon Open Compute ROCm runtime and toolchains.
hipSPARSE exposes a common interface that provides Basic Linear Algebra Subroutines for sparse computation implemented on top of the AMD ROCm runtime and toolchains.
hipSPARSE is created using the HIP programming language and optimized for AMD's latest discrete GPUs.

In the following, three separate chapters are available:
Expand Down
18 changes: 9 additions & 9 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ Building and Installing

Prerequisites
-------------
hipSPARSE requires a ROCm enabled platform, more information `here <https://rocm.github.io/>`_.
hipSPARSE requires a ROCm enabled platform.

Installing pre-built packages
-----------------------------
hipSPARSE can be installed from `AMD ROCm repository <https://rocm.github.io/ROCmInstall.html#installing-from-amd-rocm-repositories>`_.
For detailed instructions on how to set up ROCm on different platforms, see the `AMD ROCm Platform Installation Guide for Linux <https://rocm.github.io/ROCmInstall.html>`_.
hipSPARSE can be installed from AMD ROCm repository.
For detailed instructions on how to set up ROCm on different platforms, see the `AMD ROCm Platform Installation Guide for Linux <https://rocm.docs.amd.com/en/latest/deploy/linux/index.html>`_.

hipSPARSE can be installed on e.g. Ubuntu using

Expand Down Expand Up @@ -139,10 +139,10 @@ Supported Targets
-----------------
Currently, hipSPARSE is supported under the following operating systems

- `Ubuntu 18.04 <https://ubuntu.com/>`_
- `Ubuntu 20.04 <https://ubuntu.com/>`_
- `CentOS 7 <https://www.centos.org/>`_
- `CentOS 8 <https://www.centos.org/>`_
- `SLES 15 <https://www.suse.com/solutions/enterprise-linux/>`_
- Ubuntu 20.04
- Ubuntu 22.04
- RHEL 8
- RHEL 9
- SLES 15

To compile and run hipSPARSE, `AMD ROCm Platform <https://github.com/RadeonOpenCompute/ROCm>`_ is required.
To compile and run hipSPARSE, `AMD ROCm Platform <https://github.com/RadeonOpenCompute/ROCm>`_ is required.
2 changes: 1 addition & 1 deletion library/src/hcc_detail/hipsparse.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -14247,7 +14247,7 @@ hipsparseStatus_t hipsparseSpGEMM_copy(hipsparseHandle_t handle,

// cuSPARSE API does not carry over the temporary storage buffer, therefore
// we need to allocate additional memory. This will lead to lower performance
// and thus we highly recommand to use rocSPARSE API instead!!!
// and thus we highly recommend to use rocSPARSE API instead!!!

// Query for required buffer size
size_t bufferSize;
Expand Down