Skip to content

Commit

Permalink
Checks: Remove mentions of codee tools
Browse files Browse the repository at this point in the history
The descriptions of checks should be independent of the tooling that
helps detect them.
  • Loading branch information
alvrogd committed Jan 9, 2025
1 parent dc3a434 commit 44cdd84
Show file tree
Hide file tree
Showing 12 changed files with 18 additions and 47 deletions.
3 changes: 1 addition & 2 deletions Checks/PWR050/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ be sped up using [multithreading](../../Glossary/Multithreading.md).
### Actions

Implement a version of the forall loop using an Application Program Interface
(API) that enables multithreading on the CPU. Codee assists the programmer by
providing source code rewriting capabilities using OpenMP compiler directives.
(API) that enables multithreading on the CPU, such as OpenMP.

### Relevance

Expand Down
4 changes: 1 addition & 3 deletions Checks/PWR051/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@ pattern can be sped up using [multithreading](../../Glossary/Multithreading.md).
### Actions

Implement a version of the scalar reduction loop using an Application Program
Interface (API) that enables multithreading on the CPU. Codee assists the
programmer by providing source code rewriting capabilities using OpenMP compiler
directives.
Interface (API) that enables multithreading on the CPU, such as OpenMP.

### Relevance

Expand Down
4 changes: 1 addition & 3 deletions Checks/PWR052/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@ pattern can be sped up using [multithreading](../../Glossary/Multithreading.md).
### Actions

Implement a version of the sparse reduction loop using an Application Program
Interface (API) that enables multithreading on the CPU. Codee assists the
programmer by providing source code rewriting capabilities using OpenMP compiler
directives.
Interface (API) that enables multithreading on the CPU, such as OpenMP.

### Relevance

Expand Down
5 changes: 2 additions & 3 deletions Checks/PWR053/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,8 @@ can be sped up using [vectorization](../../Glossary/Vectorization.md).
### Actions

Implement a version of the forall loop using an Application Program Interface
(API) that enables vectorization. Codee assists the programmer by providing
source code rewriting capabilities using compiler directives provided by OpenMP
standard, GNU compiler, LLVM compiler and Intel compiler.
(API) that enables vectorization, such as OpenMP, or using compiler-specific
directives.

### Relevance

Expand Down
5 changes: 2 additions & 3 deletions Checks/PWR054/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,8 @@ pattern can be sped up using [vectorization](../../Glossary/Vectorization.md).
### Actions

Implement a version of the scalar reduction loop using an Application Program
Interface (API) that enables vectorization. Codee assists the programmer by
providing source code rewriting capabilities using compiler directives provided
by OpenMP standard, GNU compiler, LLVM compiler and Intel compiler.
Interface (API) that enables vectorization, or using compiler-specific
directives.

### Relevance

Expand Down
4 changes: 1 addition & 3 deletions Checks/PWR055/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@ can be sped up by [offloading it to an accelerator](../../Glossary/Offloading.md
### Actions

Implement a version of the forall loop using an Application Program Interface
(API) that enables offloading to accelerators. Codee assists the programmer by
providing source code rewriting capabilities using OpenMP and OpenACC compiler
directives.
(API) that enables offloading to accelerators, such as OpenMP or OpenACC.

### Relevance

Expand Down
6 changes: 2 additions & 4 deletions Checks/PWR056/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,8 @@ pattern can be sped up by
### Actions

Implement a version of the scalar reduction loop using an Application Program
Interface (API) that enables offloading to accelerators. Codee assists the
programmer by providing source code rewriting capabilities using
[OpenMP](https://en.wikipedia.org/wiki/OpenMP) and
[OpenACC](https://en.wikipedia.org/wiki/OpenACC) compiler directives.
Interface (API) that enables offloading to accelerators, such as OpenMP or
OpenACC.

### Relevance

Expand Down
9 changes: 3 additions & 6 deletions Checks/PWR057/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,13 @@
A loop containing the
[sparse reduction](../../Glossary/Patterns-for-performance-optimization/Sparse-reduction.md)
pattern can be sped up by
[offloading it to an accelerator](../../Glossary/Offloading.md). Codee can do this
automatically, no source code modification is needed by the developer.
[offloading it to an accelerator](../../Glossary/Offloading.md).

### Actions

Implement a version of the sparse reduction loop using an Application Program
Interface (API) that enables offloading to accelerators. Codee assists the
programmer by providing source code rewriting capabilities using
[OpenMP](https://en.wikipedia.org/wiki/OpenMP) and
[OpenACC](https://en.wikipedia.org/wiki/OpenACC) compiler directives.
Interface (API) that enables offloading to accelerators, such as OpenMP or
OpenACC.

### Relevance

Expand Down
6 changes: 1 addition & 5 deletions Checks/RMK001/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,7 @@ performance of the nested loop.
### Actions

Parallelize the outer loop using multi-threading and the inner loop using
vectorization. You can do so for OpenMP by invoking:

```bash
pwdirectives --multi omp-for+simd foo.c:5 -o foo-hybrid.c
```
vectorization.

### Relevance

Expand Down
6 changes: 1 addition & 5 deletions Checks/RMK002/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,7 @@ parallel performance of the nested loop.
### Actions

Parallelize the nested loops using offloading for the outer loop and SIMD
vectorization for the inner loop. You can do so for OpenMP by invoking:

```bash
pwdirectives --offload omp-teams+simd foo.c:5 -o foo-hybrid.c
```
vectorization for the inner loop.

### Relevance

Expand Down
7 changes: 3 additions & 4 deletions Checks/RMK014/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,9 @@ the loop body.

### Actions

Use `pwdirectives` to vectorize the loop.

Alternatively, you can perform [loop fission](../../Glossary/Loop-fission.md) to
isolate the unpredictable memory accesses to a separate loop.
Perform [loop fission](../../Glossary/Loop-fission.md) to isolate the
unpredictable memory accesses to a separate loop. If not possible, consider
evaluating the performance of the alternative scenarios described below.

### Relevance

Expand Down
6 changes: 0 additions & 6 deletions Glossary/Offloading-data-transfers.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,3 @@ layouts to reduce data transfers and memory access times.

Alternatively, the OpenACC offload directives also enable the implementation of
efficient data transfers in GPU programming.

Overall, the Codee tools support GPU programming for C/C++/Fortran using OpenMP
and OpenACC. It can automatically insert OpenMP or OpenACC directives in the
source code to offload to accelerator devices such as GPUs, helping novice
programmers to write GPU code at the expert level. Codee provides a systematic,
more predictable approach that leverages parallel programming best practices.

0 comments on commit 44cdd84

Please sign in to comment.