Skip to content

Commit cba0e4b

Browse files
authored
Fix jsons (#2140)
* Update sample.jsons for some incorrectly categorized code samples * move interfaces_comparison to Tier 1 (Getting Started)
1 parent 8d9e26c commit cba0e4b

File tree

9 files changed

+18
-19
lines changed

9 files changed

+18
-19
lines changed

DirectProgramming/C++SYCL_FPGA/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,8 @@ flowchart LR
5656
|:--- |:--- |:---
5757
| [fpga_compile](Tutorials/GettingStarted/fpga_compile) | [Tutorials/GettingStarted](Tutorials/GettingStarted) | How and why compiling SYCL* code for FPGA differs from CPU or GPU <br> FPGA device image types and when to use them. <br> The compile options used to target FPGA
5858
| [fast_recompile](Tutorials/GettingStarted/fast_recompile) | [Tutorials/GettingStarted](Tutorials/GettingStarted) | Why to separate host and device code compilation in your FPGA project <br> How to use the `-reuse-exe` and device link. <br> Which method to choose for your project
59-
| [fpga_template](Tutorials/GettingStarted/fpga_template) | [Tutorials/GettingStarted](Tutorials/GettingStarted) | Showcases the CMake build system that is used in other code samples, and serves as a template that you can re-use in your own designs.
59+
| [fpga_template](Tutorials/GettingStarted/fpga_template) | [Tutorials/GettingStarted](Tutorials/GettingStarted) | An Intel® FPGA tutorial that explains the CMake build system that is used in other code samples, and serves as a template that you can re-use in your own designs
60+
[component_interfaces_comparison](Tutorials/Features/hls_flow_interfaces/component_interfaces_comparison) | [Tutorials/Features/hls_flow_interfaces](Tutorials/Features/hls_flow_interfaces) | This sample introduces different invocation/data interfaces that can be used for IP components
6061

6162
#### Tier 2: Explore the Fundamentals
6263

@@ -80,7 +81,6 @@ flowchart LR
8081
|:--- |:--- |:---
8182
| [ac_fixed](Tutorials/Features/ac_fixed) | [Tutorials/Features](Tutorials/Features) | How different methods of `ac_fixed` number construction affect hardware resource utilization <br> Recommended method for constructing `ac_fixed` numbers in your kernel <br> Accessing and using the `ac_fixed` math library functions <br> Trading off accuracy of results for reduced resource usage on the FPGA
8283
| [ac_int](Tutorials/Features/ac_int) | [Tutorials/Features](Tutorials/Features) | Using the `ac_int` data type for basic operations <br> Efficiently using the left shift operation <br> Setting and reading certain bits of an `ac_int` number
83-
| [component_interfaces_comparison](Tutorials/Features/hls_flow_interfaces/component_interfaces_comparison) | [Tutorials/Features/hls_flow_interfaces](Tutorials/Features/hls_flow_interfaces) | This sample introduces different invocation/data interfaces that can be used when creating FPGA IP with the Intel® oneAPI DPC++/C++ Compiler
8484
| [device_global (experimental)](Tutorials/Features/experimental/device_global) | [Tutorials/Features](Tutorials/Features) | The basic usage of the `device_global` class <br> How to initialize a `device_global` to non-zero values
8585
| [double_buffering](Tutorials/DesignPatterns/double_buffering) | [Tutorials/DesignPatterns](Tutorials/DesignPatterns) | How and when to implement the double buffering optimization technique
8686
| [explicit_data_movement](Tutorials/DesignPatterns/explicit_data_movement) | [Tutorials/DesignPatterns](Tutorials/DesignPatterns) | How to explicitly manage the movement of data for the FPGA

DirectProgramming/C++SYCL_FPGA/Tutorials/Features/hls_flow_interfaces/component_interfaces_comparison/README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Component Interfaces Overview
1+
# Component Interfaces Comparison
22
This sample introduces different invocation/data interfaces that can be used when creating FPGA IP with the Intel® oneAPI DPC++/C++ Compiler.
33

44
| Area | Description
@@ -26,8 +26,7 @@ This sample introduces different invocation/data interfaces that can be used whe
2626
2727
> **Warning**: Make sure you add the device files associated with the FPGA that you are targeting to your Intel® Quartus® Prime installation.
2828
29-
This sample is part of the FPGA code samples. It is categorized as a Tier 2 sample that demonstrates compiler features.
30-
29+
This sample is part of the FPGA code samples. It is categorized as a Tier 1 sample that helps you getting started.
3130
```mermaid
3231
flowchart LR
3332
tier1("Tier 1: Get Started")
@@ -37,8 +36,8 @@ flowchart LR
3736
3837
tier1 --> tier2 --> tier3 --> tier4
3938
40-
style tier1 fill:#0071c1,stroke:#0071c1,stroke-width:1px,color:#fff
41-
style tier2 fill:#f96,stroke:#333,stroke-width:1px,color:#fff
39+
style tier1 fill:#f96,stroke:#333,stroke-width:1px,color:#fff
40+
style tier2 fill:#0071c1,stroke:#0071c1,stroke-width:1px,color:#fff
4241
style tier3 fill:#0071c1,stroke:#0071c1,stroke-width:1px,color:#fff
4342
style tier4 fill:#0071c1,stroke:#0071c1,stroke-width:1px,color:#fff
4443
```

DirectProgramming/C++SYCL_FPGA/Tutorials/Features/hls_flow_interfaces/component_interfaces_comparison/sample.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"guid": "7d8482f5-39f1-4cf1-aa2e-a1f72cfc47cb",
3-
"name": "SYCL HLS Flow Interfaces Overview",
4-
"categories": ["Toolkit/oneAPI Direct Programming/C++SYCL FPGA/Tutorials/Features"],
5-
"description": "Intel® FPGA example designs oversewing different interfaces for the SYCL HLS flow",
3+
"name": "Component Interfaces Comparison",
4+
"categories": ["Toolkit/oneAPI Direct Programming/C++SYCL FPGA/Getting Started Tutorials"],
5+
"description": "Intel® FPGA tutorial introducing different invocation/data interfaces that can be used for IP components",
66
"toolchain": ["icpx"],
77
"os": ["linux", "windows"],
88
"targetDevice": ["FPGA"],

DirectProgramming/C++SYCL_FPGA/Tutorials/Features/hls_flow_interfaces/invocation_interfaces/sample.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"guid": "69415BED-D452-449A-8F5A-DB01ACCE38DC",
33
"name": "Invocation Interfaces",
4-
"categories": ["Toolkit/oneAPI Direct Programming/C++SYCL FPGA/Tutorials/Features/hls_flow_interfaces"],
5-
"description": "An Intel® FPGA tutorial demonstrating the usage of register_map and streaming invocation interfaces",
4+
"categories": ["Toolkit/oneAPI Direct Programming/C++SYCL FPGA/Tutorials/Features/HLS Flow: Interfaces"],
5+
"description": "An Intel® FPGA tutorial that demonstrates the differences between a streaming invocation interface and a register-mapped invocation interface on an IP component",
66
"toolchain": ["icpx"],
77
"os": ["linux", "windows"],
88
"targetDevice": ["FPGA"],

DirectProgramming/C++SYCL_FPGA/Tutorials/Features/hls_flow_interfaces/mmhost/sample.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"guid": "CE509751-B84A-44D1-A391-2007937F3A7F",
33
"name": "Avalon Memory-Mapped Host Interfaces",
4-
"categories": ["Toolkit/oneAPI Direct Programming/C++SYCL FPGA/Tutorials/Features/hls_flow_interfaces"],
5-
"description": "An Intel® FPGA tutorial demonstrating how to use annotated pointers to customize Avalon memory-mapped host interfaces",
4+
"categories": ["Toolkit/oneAPI Direct Programming/C++SYCL FPGA/Tutorials/Features/HLS FLow: Interfaces"],
5+
"description": "An Intel® FPGA tutorial demonstrating how to annotate pointer arguments to customize Avalon memory-mapped host interfaces",
66
"toolchain": ["icpx"],
77
"os": ["linux", "windows"],
88
"targetDevice": ["FPGA"],

DirectProgramming/C++SYCL_FPGA/Tutorials/Features/hls_flow_interfaces/streaming_data_interfaces/sample.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"guid": "aeaca2ce-126e-452b-a6e3-2a3d5b1dbf55",
3-
"name": "Streaming Interfaces",
4-
"categories": ["Toolkit/oneAPI Direct Programming/C++SYCL FPGA/Tutorials/hls_flow_interfaces/streaming_data_interfaces"],
3+
"name": "Streaming Data Interfaces",
4+
"categories": ["Toolkit/oneAPI Direct Programming/C++SYCL FPGA/Tutorials/HLS Flow: Interfaces"],
55
"description": "An Intel® FPGA tutorial demonstrating how to use pipes to implement streaming interfaces on IP Components",
66
"toolchain": ["icpx"],
77
"os": ["linux", "windows"],

DirectProgramming/C++SYCL_FPGA/Tutorials/GettingStarted/fpga_compile/sample.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"guid": "A211FDE2-B037-4069-BD84-C45E354798B7",
33
"name": "FPGA Compile",
44
"categories": ["Toolkit/oneAPI Direct Programming/C++SYCL FPGA/Getting Started Tutorials"],
5-
"description": "Intel® FPGA tutorial introducing how to SYCL for Intel® FPGA",
5+
"description": "Intel® FPGA tutorial introducing how to use SYCL to target FPGAs",
66
"toolchain": ["icpx"],
77
"os": ["linux", "windows"],
88
"targetDevice": ["FPGA"],

DirectProgramming/C++SYCL_FPGA/Tutorials/GettingStarted/fpga_template/sample.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"guid": "418AA4D8-0A61-4FDB-845A-CDA4DA0655E7",
33
"name": "FPGA Template",
44
"categories": ["Toolkit/oneAPI Direct Programming/C++SYCL FPGA/Getting Started Tutorials"],
5-
"description": "This project serves as a template for Intel® oneAPI DPC++/C++ designs targeting FPGAs. ",
5+
"description": "An Intel® FPGA tutorial that explains the CMake build system that is used in other code samples, and serves as a template that you can re-use in your own designs",
66
"toolchain": ["icpx"],
77
"os": ["linux", "windows"],
88
"targetDevice": ["FPGA"],

DirectProgramming/C++SYCL_FPGA/Tutorials/Tools/platform_designer/sample.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"guid": "293B78FB-40A3-4F81-A3CB-D2C3ED344AE1",
33
"name": "Platform Designer - Intel® Arria® 10 SX SoC Developer Kit",
4-
"categories": ["Toolkit/oneAPI Direct Programming/C++SYCL FPGA/Tutorials/Tools/experimental"],
4+
"categories": ["Toolkit/oneAPI Direct Programming/C++SYCL FPGA/Tutorials/Tools"],
55
"description": "An Intel® FPGA tutorial demonstrating how to export a reusable IP component to Intel® Quartus® Prime Pro and Platform Designer.",
66
"toolchain": ["icpx"],
77
"os": ["linux", "windows"],

0 commit comments

Comments
 (0)