sample.json

Each code sample must have a sample.json file. An example of a sample.json file (this one taken directly from the matrix_mul code sample) may look something like this:

{
  "guid": "E6115777-E2CE-4839-8900-24DC3D1AD572",
  "name": "Matrix Multiply",
  "categories": ["Toolkit/Get Started", "Toolkit/oneAPI Direct Programming/C++SYCL/Dense Linear Algebra"],
  "description": "This sample Multiplies two large Matrices in parallel using SYCL and OpenMP* (OMP)",
  "toolchain": [ "dpcpp", "icc" ],
  "dependencies": [ "compiler|icc" ],
  "languages": [ { "cpp": { "properties": { "projectOptions": [ { "projectType": "makefile" } ] } } } ],
  "targetDevice": [ "CPU", "GPU" ],
  "os": [ "linux", "windows" ],
  "builder": [ "ide", "make" ],
  "ciTests": {
    "linux": [
      {
        "id": "matrix_mul_sycl",
        "steps": [
          "make clean",
          "make all",
          "make run"
        ]
      },
      {
        "id": "matrix_mul_omp",
        "steps": [
          "make clean",
          "make build_omp",
          "make run_omp"
        ]
      }
    ],
    "windows": [
      {
        "id": "matrix_mul_sycl",
        "steps": [
          "nmake -f Makefile.win build_sycl",
          "nmake -f Makefile.win run_dsycl"
        ]
      }
    ]
  },
  "expertise": "Getting Started"
}

Before submitting a pull request, please use the sample_json_validator.py script to verify that your sample.json file is valid.