Skip to content

Commit b35faee

Browse files
committed
rename sample
1 parent 754078b commit b35faee

File tree

7 files changed

+13
-13
lines changed

7 files changed

+13
-13
lines changed

DirectProgramming/C++SYCL_FPGA/Tutorials/DesignPatterns/restartable_kernel/README.md renamed to DirectProgramming/C++SYCL_FPGA/Tutorials/DesignPatterns/restartable_streaming_kernel/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# `Restartable Kernel` Sample
1+
# `Restartable Streaming Kernel` Sample
22

3-
This tutorial demonstrates how to make a restartable kernel. The technique shown in this tutorial lets you dynamically terminate your kernel while it runs, allowing it to load a new set of kernel arguments.
3+
This tutorial demonstrates how to make a streaming kernel that can be stopped at any time by the host application, then restarted again at a later time. The technique shown in this tutorial lets you dynamically terminate your kernel while it runs, allowing it to load a new set of kernel arguments.
44

55
| Optimized for | Description |
66
| :------------------ | :------------------------------------------------------------------------------------------ |
@@ -97,17 +97,17 @@ The testbench in `main.cpp` exercises the kernel in the following steps:
9797

9898
### Packets
9999

100-
This design uses the Avalon `start_of_packet` signal to indicate when the a new set of values is being written to `OutputPipe`. The `start_of_packet` sideband signal is not *generally* necessary for implementing a restartable kernel, but it is used in this design to compensate for the decoupled way that the `RestartableCounter` kernel executes with respect to the host code. Since the host code does not tell `RestartableCounter` how many values to write to `OutputPipe`, the `RestartableCounter` will continue to write to `OutputPipe` until either
100+
This design uses the Avalon `start_of_packet` signal to indicate when the a new set of values is being written to `OutputPipe`. The `start_of_packet` sideband signal is not *generally* necessary for implementing a restartable streaming kernel, but it is used in this design to compensate for the decoupled way that the `RestartableCounter` kernel executes with respect to the host code. Since the host code does not tell `RestartableCounter` how many values to write to `OutputPipe`, the `RestartableCounter` will continue to write to `OutputPipe` until either
101101

102102
1. `OutputPipe` fills up, in which case the `RestartableCounter` kernel will stop incrementing its internal counter until the pipe can be written to again
103103

104104
2. A `true` is written to the `StopPipe`
105105

106106
Any data written to the `OutputPipe` between the host code writing a `true` to `StopPipe`, and the `RestartableCounter` kernel *consuming* the `true` from `StopPipe` will still be in `OutputPipe` the next time the host code tries to read from it, so it is necessary to flush these extra beats of data. The `start_of_packet` sideband signals the beginning of a new stream of counter data in `OutputPipe`.
107107

108-
![](assets/restartable_kernel_sequence_diagram.svg)
108+
![](assets/restartable_streaming_kernel_sequence_diagram.svg)
109109

110-
## Building the `restartable_kernel` Tutorial
110+
## Building the `restartable_streaming_kernel` Tutorial
111111

112112
> **Note**: When working with the command-line interface (CLI), you should configure the oneAPI toolkits using environment variables.
113113
> Set up your CLI environment by sourcing the `setvars` script located in the root of your oneAPI installation every time you open a new terminal window.
@@ -228,7 +228,7 @@ This design uses CMake to generate a build script for `nmake`.
228228
> C:\samples\build> cmake -G "NMake Makefiles" C:\long\path\to\code\sample\CMakeLists.txt
229229
> ```
230230
231-
## Run the `restartable_kernel` Executable
231+
## Run the `restartable_streaming_kernel` Executable
232232
233233
### On Linux
234234
Lines changed: 3 additions & 3 deletions
Loading

DirectProgramming/C++SYCL_FPGA/Tutorials/DesignPatterns/restartable_kernel/sample.json renamed to DirectProgramming/C++SYCL_FPGA/Tutorials/DesignPatterns/restartable_streaming_kernel/sample.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"guid": "393AA016-DF50-40A7-A9D4-DA389B29CACF",
3-
"name": "Restartable Kernel",
3+
"name": "Restartable Streaming Kernel",
44
"categories": ["Toolkit/oneAPI Direct Programming/C++SYCL FPGA/Tutorials/Design Patterns"],
55
"description": "An Intel® FPGA tutorial that demonstrates how to create a kernel that can be stopped at any time by your host application.",
66
"toolchain": ["icpx"],
@@ -12,7 +12,7 @@
1212
"base": "../../..",
1313
"include": [
1414
"README.md",
15-
"Tutorials/DesignPatterns/restartable_kernel",
15+
"Tutorials/DesignPatterns/restartable_streaming_kernel",
1616
"include"
1717
],
1818
"exclude": []
@@ -49,7 +49,7 @@
4949
"cd ../../..",
5050
"mkdir build",
5151
"cd build",
52-
"cmake -G \"NMake Makefiles\" ../Tutorials/DesignPatterns/restartable_kernel",
52+
"cmake -G \"NMake Makefiles\" ../Tutorials/DesignPatterns/restartable_streaming_kernel",
5353
"nmake fpga_emu",
5454
"restartable.fpga_emu.exe"
5555
]
@@ -61,7 +61,7 @@
6161
"cd ../../..",
6262
"mkdir build",
6363
"cd build",
64-
"cmake -G \"NMake Makefiles\" ../Tutorials/DesignPatterns/restartable_kernel",
64+
"cmake -G \"NMake Makefiles\" ../Tutorials/DesignPatterns/restartable_streaming_kernel",
6565
"nmake report"
6666
]
6767
}

0 commit comments

Comments
 (0)