Skip to content

Commit

Permalink
The spellchecker and markdown checker are fixed
Browse files Browse the repository at this point in the history
  • Loading branch information
neon60 committed Nov 26, 2023
1 parent 4ef4f2b commit ff8d501
Show file tree
Hide file tree
Showing 6 changed files with 4 additions and 33 deletions.
11 changes: 0 additions & 11 deletions .markdownlint.yaml

This file was deleted.

1 change: 1 addition & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ GoogleTest
hipSPARSELt
LeakyReLU
ReLU
rocSPARSELt
sudo
SpMM
Tanh
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/porting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ For example, the hipSPARSELt matrix multiplication interface is:

Matrix multiplication API

.. <!-- spellcheck-disable -->
.. code-block:: c
hipsparseStatus_t hipsparseLtMatmul(const hipsparseLtHandle_t* handle,
Expand All @@ -30,7 +29,6 @@ Matrix multiplication API
void* workspace,
hipStream_t* streams,
int32_t numStreams);
.. <!-- spellcheck-enable -->
hipSPARSELt assumes matrix A, B, C, D and workspace are allocated in GPU memory space filled with
data. Users are responsible for copying data from/to the host and device memory.
4 changes: 0 additions & 4 deletions docs/reference/storage-format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,16 @@ hipSPARSELt uses a structured sparsity storage format, which is represented by a
Consider the following :math:`4 \times 4` matrix and the structured sparsity structures using
:math:`m = 4, n = 4`:

.. <!-- spellcheck-disable -->
.. math::
A = \begin{pmatrix}
1.0 & 2.0 & 0.0 & 0.0 \\
0.0 & 0.0 & 3.0 & 4.0 \\
0.0 & 6.0 & 7.0 & 0.0 \\
0.0 & 6.0 & 0.0 & 8.0 \\
\end{pmatrix}
.. <!-- spellcheck-enable -->
where

.. <!-- spellcheck-disable -->
.. math::
Compressed A = \begin{pmatrix}
1.0 & 2.0 \\
Expand All @@ -49,4 +46,3 @@ where
1 & 2 \\
1 & 3 \\
\end{pmatrix}
.. <!-- spellcheck-enable -->
17 changes: 3 additions & 14 deletions docs/tutorials/install/linux.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,10 @@ For detailed instructions on how to set up ROCm on different platforms, refer to

Using Ubuntu as an example, hipSPARSELt can be installed using

.. <!-- spellcheck-disable -->
.. code-block:: bash
sudo apt-get update
sudo apt-get install hipsparselt
.. <!-- spellcheck-enable -->
Once installed, hipSPARSELt can be used just like any other library with a C API.

Expand Down Expand Up @@ -62,12 +60,10 @@ The hipSPARSELt source code is available on our

Download the develop branch using:

.. <!-- spellcheck-disable -->
.. code-block:: bash
git clone -b develop https://github.com/ROCmSoftwarePlatform/hipSPARSELt.git
cd hipSPARSELt
.. <!-- spellcheck-enable -->
Build library packages, including dependencies and clients
--------------------------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -107,7 +103,6 @@ We recommended installing hipSPARSELt using the ``install.sh`` script.

CMake 3.16.8 or later is required in order to build hipSPARSELt.

.. <!-- spellcheck-disable -->
.. code-block:: bash
# Create and change the build directory
Expand All @@ -125,9 +120,7 @@ We recommended installing hipSPARSELt using the ``install.sh`` script.
GoogleTest is required in order to build hipSPARSELt clients.
Build hipSPARSELt with dependencies and clients using the following commands:
.. <!-- spellcheck-enable -->
.. <!-- spellcheck-disable -->
.. code-block:: bash
# Install googletest
Expand All @@ -146,27 +139,24 @@ We recommended installing hipSPARSELt using the ``install.sh`` script.
# Install hipSPARSELt to /opt/rocm
$ make install
.. <!-- spellcheck-enable -->
Testing the installation
==========================================

After successfully compiling the library with clients, you can test the installation by running a hipSPARSELt example:

.. <!-- spellcheck-disable -->
.. code-block:: bash
# Navigate to clients binary directory
$ cd hipSPARSELt/build/release/clients/staging
# Execute hipSPARSELt example
$ ./example_spmm_strided_batched -m 32 -n 32 -k 32 --batch_count 1
.. <!-- spellcheck-enable -->
Running benchmarks & unit tests
----------------------------------------------------------------------------
.. <!-- spellcheck-disable -->
To run **benchmarks**, hipSPARSELt has to be built with option -DBUILD_CLIENTS_BENCHMARKS=ON (or using ./install.sh -c).

To run **benchmarks**, hipSPARSELt has to be built with option `-DBUILD_CLIENTS_BENCHMARKS=ON` (or using `./install.sh -c`).

.. code-block:: bash
Expand All @@ -176,7 +166,7 @@ To run **benchmarks**, hipSPARSELt has to be built with option -DBUILD_CLIENTS_B
# Run benchmark, e.g.
./clients/staging/hipsparselt-bench -f spmm -i 200 -m 256 -n 256 -k 256
To run **unit tests**, hipSPARSELt has to be built with option -DBUILD_CLIENTS_TESTS=ON (or using ./install.sh -c)
To run **unit tests**, hipSPARSELt has to be built with option `-DBUILD_CLIENTS_TESTS=ON` (or using `./install.sh -c`)

.. code-block:: bash
Expand All @@ -185,4 +175,3 @@ To run **unit tests**, hipSPARSELt has to be built with option -DBUILD_CLIENTS_T
# Run all tests
./clients/staging/hipsparselt-test
.. <!-- spellcheck-enable -->
2 changes: 0 additions & 2 deletions docs/tutorials/quick-start/linux.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ doesn't take a lot of options and hard-codes configuration that can be specified
CMake directly, but it's a great way to get started quickly and can serve as an example of how to build
and install. A few commands in the script need sudo access, so it may prompt you for a password.

.. <!-- spellcheck-disable -->
.. code-block:: bash
# Run install.sh script
Expand All @@ -28,6 +27,5 @@ and install. A few commands in the script need sudo access, so it may prompt you
# -k|--relwithdebinfo - build with RelWithDebInfo
./install.sh -dc
.. <!-- spellcheck-enable -->
For a more in-depth installation guide, see :ref:`install-linux`.

0 comments on commit ff8d501

Please sign in to comment.