Merge pull request #1804 from krisrak/20230724-genhelper

jimmytwei · web-flow · commit dbbe8237ca5a · 2023-07-24T17:10:52.000-07:00
updated c2s cmd line option --gen-helper-function
diff --git a/DirectProgramming/C++SYCL/Jupyter/cuda-to-sycl-migration-training/00_SYCL_Migration_Introduction/00_SYCL_Migration_Introduction.ipynb b/DirectProgramming/C++SYCL/Jupyter/cuda-to-sycl-migration-training/00_SYCL_Migration_Introduction/00_SYCL_Migration_Introduction.ipynb
@@ -158,7 +158,7 @@
     "  - In home directory or anywhere: `mkdir syclomatic; cd syclomatic`\n",
     "  - `wget <link to linux_release.tgz>`\n",
     "  - `tar –xvf linux_release.tgz`\n",
-    "  - `export PATH=“/home/$USER/syclomatic/bin:$PATH”`\n",
+    "  - `export PATH=\"/home/$USER/syclomatic/bin:$PATH\"`\n",
     "  - `c2s --version`\n",
     "  \n",
     "### SYCLomatic tool usage\n",
@@ -168,7 +168,7 @@
     "- Migrate a single CUDA source file:\n",
     "  - `c2s test.cu`\n",
     "- Migrate a single CUDA source file and copy all syclomatic helper header files:\n",
-    "  - `c2s test.cu --use-custom-helper=all/file/api`\n",
+    "  - `c2s test.cu --gen-helper-function`\n",
     "- Migrate a single CUDA source to a specific directory name\n",
     "  - `c2s test.cu --out-root sycl_code`\n",
     "- Migrate a single CUDA source with source root tree\n",
@@ -177,23 +177,26 @@
     "  - `c2s test.cu --cuda-include-path /tmp/cuda/include`\n",
     "- Migrate a CUDA project with makefile:\n",
     "  - `intercept-build make`\n",
-    "  - `c2s -p compile_command.json`\n",
+    "  - `c2s -p compile_command.json` OR `c2s -p .`\n",
+    "- Migrate a CUDA project with makefile and generate makefile for building SYCL:\n",
+    "  - `intercept-build make`\n",
+    "  - `c2s -p . --gen-build-script`\n",
     "\n",
     "\n",
     "### Compiling SYCL on Intel and Other hardware\n",
     "\n",
     "- Install __Intel oneAPI C++/DPC++ Compiler__ or __Intel oneAPI Base Toolkit__\n",
     "- Install CUDA Plugin for oneAPI from CodePlay \n",
-    "- Link to [Installation Instructions](https://developer.codeplay.com/products/oneapi/nvidia/2023.0.0/guides/get-started-guide-nvidia)\n",
+    "- Link to [Installation Instructions](https://developer.codeplay.com/products/oneapi/nvidia/)\n",
     "\n",
     "- Set environment variable for using the Compiler\n",
-    "  - `source /opt/intel/oneapi/setvars.sh --include-intel-llvm`\n",
+    "  - `source /opt/intel/oneapi/setvars.sh`\n",
     "\n",
     "- Compile SYCL for Intel CPUs/GPUs\n",
     "  - `icpx –fsycl test.cpp`\n",
     "\n",
     "- Compile SYCL for Nvidia* GPUs\n",
-    "  - `clang++ -fsycl -fsycl-targets=nvptx64-nvidia-cuda test.cpp`\n",
+    "  - `icpx -fsycl -fsycl-targets=nvptx64-nvidia-cuda test.cpp`\n",
     "\n",
     "### Program Structure of Migrated SYCL code\n",
     "\n",
@@ -259,7 +262,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (Intel® oneAPI 2023.0)",
+   "display_name": "Python 3 (Intel® oneAPI 2023.2)",
    "language": "python",
    "name": "c009-intel_distribution_of_python_3_oneapi-beta05-python"
   },
@@ -273,7 +276,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.15"
+   "version": "3.9.16"
   }
  },
  "nbformat": 4,
diff --git a/DirectProgramming/C++SYCL/Jupyter/cuda-to-sycl-migration-training/01_SYCL_Migration_Simple_VectorAdd/01_SYCL_Migration_Simple_VectorAdd.ipynb b/DirectProgramming/C++SYCL/Jupyter/cuda-to-sycl-migration-training/01_SYCL_Migration_Simple_VectorAdd/01_SYCL_Migration_Simple_VectorAdd.ipynb
@@ -155,19 +155,19 @@
     "On the NVIDIA CUDA development machine, run the following command to migrate CUDA code to SYCL code:\n",
     "\n",
     "```\n",
-    "c2s vectoradd.cu --use-custom-helper=api\n",
+    "c2s vectoradd.cu --gen-helper-function\n",
     "```\n",
     "\n",
     "This command should migrate the CUDA source to SYCL source in a folder named `dpct_output/` by default, and the folder will have the SYCL source with name `vectoradd.dp.cpp`\n",
     "\n",
-    "`--use-custom-helper=api` option will copy the SYCLomatic helper headers filed to output directory\n",
+    "`--gen-helper-function` option will copy the SYCLomatic helper headers filed to output directory\n",
     "\n",
-    "Note that when running the tool again for the same source may throw error that `dpct_output` folder is not empty, so make sure to delete the `dpct_output` folder and then try the `c2s vectoradd.cu --use-custom-helper=api` command.\n",
+    "Note that when running the tool again for the same source may throw error that `dpct_output` folder is not empty, so make sure to delete the `dpct_output` folder and then try the `c2s vectoradd.cu --gen-helper-function` command.\n",
     "\n",
     "Next we will use the `c2s --out-root` option to specify a custom output directory like shown below:\n",
     "\n",
     "```\n",
-    "c2s vectoradd.cu --use-custom-helper=api --out-root sycl_code\n",
+    "c2s vectoradd.cu --gen-helper-function --out-root sycl_code\n",
     "```\n",
     "\n",
     "This command should migrate the CUDA source to SYCL source in a folder named `sycl_code`\n",
@@ -474,7 +474,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (Intel® oneAPI 2023.0)",
+   "display_name": "Python 3 (Intel® oneAPI 2023.2)",
    "language": "python",
    "name": "c009-intel_distribution_of_python_3_oneapi-beta05-python"
   },
@@ -488,7 +488,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.15"
+   "version": "3.9.16"
   }
  },
  "nbformat": 4,
diff --git a/DirectProgramming/C++SYCL/Jupyter/cuda-to-sycl-migration-training/02_SYCL_Migration_SortingNetworks/02_SYCL_Migration_SortingNetworks.ipynb b/DirectProgramming/C++SYCL/Jupyter/cuda-to-sycl-migration-training/02_SYCL_Migration_SortingNetworks/02_SYCL_Migration_SortingNetworks.ipynb
@@ -147,10 +147,10 @@
     "Next, use the SYCLomatic Tool (c2s) to migrate the code; it will store the result in the migration folder `dpct_output`:\n",
     "\n",
     "```\n",
-    "c2s -p compile_commands.json --in-root ../../.. --use-custom-helper=api\n",
+    "c2s -p compile_commands.json --in-root ../../.. --gen-helper-function\n",
     "```\n",
     "\n",
-    "The `--use-custom-helper=api` option will copy the SYCLomatic helper header files to output directory.\n",
+    "The `--gen-helper-function` option will copy the SYCLomatic helper header files to output directory.\n",
     "\n",
     "The `--in-root` option will specify the path for all the common include files for the CUDA project.\n",
     "\n",
@@ -335,7 +335,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (Intel® oneAPI 2023.0)",
+   "display_name": "Python 3 (Intel® oneAPI 2023.2)",
    "language": "python",
    "name": "c009-intel_distribution_of_python_3_oneapi-beta05-python"
   },
@@ -349,7 +349,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.15"
+   "version": "3.9.16"
   }
  },
  "nbformat": 4,
diff --git a/DirectProgramming/C++SYCL/Jupyter/cuda-to-sycl-migration-training/03_SYCL_Migration_Jacobi_Iterative/03_SYCL_Migration_Jacobi_Iterative.ipynb b/DirectProgramming/C++SYCL/Jupyter/cuda-to-sycl-migration-training/03_SYCL_Migration_Jacobi_Iterative/03_SYCL_Migration_Jacobi_Iterative.ipynb
@@ -148,12 +148,12 @@
     "Next, use the SYCLomatic Tool (c2s) to migrate the code; it will store the result in the migration folder `dpct_output`:\n",
     "\n",
     "```\n",
-    "c2s -p compile_commands.json --in-root ../../.. --use-custom-helper=api --use-experimental-features=logical-group\n",
+    "c2s -p compile_commands.json --in-root ../../.. --gen-helper-function --use-experimental-features=logical-group\n",
     "```\n",
     "\n",
     "`-use-experimental-features=logical-group` option is needed since this CUDA example is using CUDA cooperative groups, and SYCLomatic will migrate this using a experimemtal feature currently.\n",
     "\n",
-    "The `--use-custom-helper=api` option will copy the SYCLomatic helper header files to output directory.\n",
+    "The `--gen-helper-function` option will copy the SYCLomatic helper header files to output directory.\n",
     "\n",
     "The `--in-root` option will specify the path for all the common include files for the CUDA project.\n",
     "\n",
@@ -443,7 +443,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (Intel® oneAPI 2023.0)",
+   "display_name": "Python 3 (Intel® oneAPI 2023.2)",
    "language": "python",
    "name": "c009-intel_distribution_of_python_3_oneapi-beta05-python"
   },
@@ -457,7 +457,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.15"
+   "version": "3.9.16"
   }
  },
  "nbformat": 4,
diff --git a/DirectProgramming/C++SYCL/Jupyter/cuda-to-sycl-migration-training/04_SYCL_Migration_MatrixMul_CuBlas/04_SYCL_Migration_MatrixMul_CuBlas.ipynb b/DirectProgramming/C++SYCL/Jupyter/cuda-to-sycl-migration-training/04_SYCL_Migration_MatrixMul_CuBlas/04_SYCL_Migration_MatrixMul_CuBlas.ipynb
@@ -133,10 +133,10 @@
     "Next, use the SYCLomatic Tool (c2s) to migrate the code; it will store the result in the migration folder `dpct_output`:\n",
     "\n",
     "```\n",
-    "c2s -p compile_commands.json --in-root ../../.. --use-custom-helper=api\n",
+    "c2s -p compile_commands.json --in-root ../../.. --gen-helper-function\n",
     "```\n",
     "\n",
-    "The `--use-custom-helper=api` option will copy the SYCLomatic helper header files to output directory.\n",
+    "The `--gen-helper-function` option will copy the SYCLomatic helper header files to output directory.\n",
     "\n",
     "The `--in-root` option will specify the path for all the common include files for the CUDA project.\n",
     "\n",
@@ -296,7 +296,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (Intel® oneAPI 2023.0)",
+   "display_name": "Python 3 (Intel® oneAPI 2023.2)",
    "language": "python",
    "name": "c009-intel_distribution_of_python_3_oneapi-beta05-python"
   },
@@ -310,7 +310,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.15"
+   "version": "3.9.16"
   }
  },
  "nbformat": 4,
