Skip to content

Commit

Permalink
Fix format issue in README
Browse files Browse the repository at this point in the history
  • Loading branch information
CongMa13 committed Dec 8, 2023
1 parent 67aebeb commit ba2fecf
Showing 1 changed file with 18 additions and 9 deletions.
27 changes: 18 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,19 @@ python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html

### Operations - Contraction Tensor

hiptensor supports a tensor contraction of the form $D = \alpha AB + \beta C$

Supported data-type combinations are:

| typeA | typeB | typeC | typeCompute | notes |
|-----------|-----------|-----------|-----------------|----------------------------------|
| bf16 | bf16 | bf16 | f32 | |
| __half | __half | __half | f32 | |
| f32 | f32 | f32 | bf16 | |
| f32 | f32 | f32 | __half | |
| f32 | f32 | f32 | f32 | |
| f64 | f64 | f64 | f32 | f64 is supported only on gfx90 + |
| f64 | f64 | f64 | f64 | f64 is supported only on gfx90 + |
| typeA | typeB | typeC | typeCompute | notes |
| ----------- | ----------- | ----------- | ----------------- | ---------------------------------- |
| bf16 | bf16 | bf16 | f32 | |
| __half | __half | __half | f32 | |
| f32 | f32 | f32 | bf16 | |
| f32 | f32 | f32 | __half | |
| f32 | f32 | f32 | f32 | |
| f64 | f64 | f64 | f32 | f64 is supported only on gfx90a + |
| f64 | f64 | f64 | f64 | f64 is supported only on gfx90a + |

### Operations - Permutation Tensor

Expand Down Expand Up @@ -119,6 +121,7 @@ After configuration, build with `cmake --build <build_dir> -- -j<nproc>`
### Logger tests

Tests API implementation of logger verbosity and functionality.

```bash
<build_dir>/bin/logger_test
```
Expand All @@ -128,13 +131,15 @@ Tests API implementation of logger verbosity and functionality.
### Bilinear contraction tests

Tests the API implementation of bilinear contraction algorithm with validation.

```bash
<build_dir>/bin/bilinear_contraction_test
```

### Scale contraction tests

Tests the API implementation of scale contraction algorithm with validation.

```bash
<build_dir>/bin/scale_contraction_test
```
Expand All @@ -143,6 +148,7 @@ Tests the API implementation of scale contraction algorithm with validation.

### Permutation tests

Check failure on line 149 in README.md

View workflow job for this annotation

GitHub Actions / Documentation / Markdown

Headings should be surrounded by blank lines

README.md:149 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Permutation tests"] https://github.com/DavidAnson/markdownlint/blob/v0.28.2/doc/md022.md
Tests API implementation of permutation algorithm with validation.

```bash
<build_dir>/bin/permutation_test
```
Expand All @@ -154,20 +160,23 @@ These are stand-alone use-cases of the hipTensor contraction operations.
### F32 Bilinear contraction

Demonstrates the API implementation of bilinear contraction operation without validation.

```bash
<build_dir>/bin/simple_bilinear_contraction_<typeA>_<typeB>_<typeC>_<typeD>_compute_<computeType>
```

### F32 Scale contraction

Demonstrates the API implementation of scale contraction operation without validation.

```bash
<build_dir>/bin/simple_scale_contraction_<typeA>_<typeB>_<typeD>_compute_<typeCompute>
```

### Permutation

Demonstrates the API implementation of permutation operation without validation.

```bash
<build_dir>/bin/simple_permutation
```
Expand Down

0 comments on commit ba2fecf

Please sign in to comment.