Skip to content

Commit 2aa9180

Browse files
authored
Update automation (oneapi-src#880)
* Update content.json * Update README.md * updating Automated files, add missing license files and added fix for guid.json Signed-off-by: JoeOster <[email protected]> * updating Automated files, add missing license files and added fix for guid.json Signed-off-by: JoeOster <[email protected]> * Update create_docs.py * fix for guid.json Signed-off-by: JoeOster <[email protected]>
1 parent c2c86d9 commit 2aa9180

File tree

12 files changed

+181
-76
lines changed

12 files changed

+181
-76
lines changed

.repo-tools/Docs_Automation/content.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"mdIntro3.3":"* [Libraries](https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries)\n * [oneCCl](https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneCCL)\n * [oneDAL](https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneDAL)\n * [oneDNN](https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneDNN)\n * [oneDPL](https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneDPL)\n * [oneMKL](https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneMKL)\n * [oneTBB](https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneTBB)\n * [oneVPL](https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneVPL)\n",
1313
"mdIntro3.4":"* [Publications](https://github.com/oneapi-src/oneAPI-samples/Publications/)\n * [Data Parallel C++](https://github.com/oneapi-src/oneAPI-samples/Publications/Data_Parallel_C%2B%2B)\n",
1414
"mdIntro3.5":"* [Tools](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/)\n * [Advisor](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/Advisor)\n * [Application Debugger](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/ApplicationDebugger)\n * [Benchmark](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/Benchmark)\n * [IoT Connections Tools](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/IoTConnectionsTools)\n * [Migration](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/Migration)\n * [Socwatch](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/Socwatch)\n * [Trace](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/Trace)\n * [UEFI debug](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/UEFI%20debug)\n * [VTune Profiler](https://github.com/oneapi-src/oneAPI-samples/tree/master/Tools/VTuneProfiler)\n)",
15-
"mdIntro4":"## Additional Resources\n- Samples in [Alphabetical order w/ device target](https://github.com/oneapi-src/CODESAMPLESLIST.md/)\n- Samples by [Change History](https://github.com/oneapi-src/oneAPI-samples/CHANGELOGS.md)",
15+
"mdIntro4":"## Additional Resources\n- Samples in [Alphabetical order w/ device target](https://github.com/oneapi-src/oneAPI-samples/blob/master/CODESAMPLESLIST.md)\n- Samples by [Change History](https://github.com/oneapi-src/oneAPI-samples/blob/master/CHANGELOGS.md)",
1616
"mdIntro5":"\n\n## Known Issues or Limitations\n\n### On Windows Platform\n\n",
1717
"mdIntro5.1":"- If you are using Visual Studio 2019, Visual Studio 2019 version 16.4.0 or newer is required.",
1818
"mdIntro5.2":"- Windows support for the FPGA code samples is limited to the FPGA emulator and optimization reports. Compile targets for FPGA hardware are provided on Linux only. See any FPGA code sample for more details.",
@@ -31,4 +31,4 @@
3131

3232
"mdChangeLogHeaderp1":"## oneAPI Code Sample Change log\n\nThis document shows the history of when a specific sample was introduced to the oneAPI ecosystem of Code Samples.",
3333
"mdChangeLogHeaderp2":"\n| Version|Code Sample Name|description|\n|-----------------------|------------------|-------------------------|\n"
34-
}
34+
}

.repo-tools/Docs_Automation/create_docs.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ def generateChangeLogLines(currentData, guidsVersions):
7272
url = currentData[key]['url']
7373
name = currentData[key]['name']
7474
cat = str(currentData[key]['categories'])
75-
except KeyError as e:
75+
except KeyError as e: # currently this is throwing a poor error message, for example IoT samples was left in GUID.json, but removed from repo... the message below is inaccurate and should be GUID missing from current Data... so improvements are needed.
7676
print("\tWarning with: " + key + " Missing from guids.json\n\t\t" + guidsVersions[key]['notes'][:50] + "...")
7777
continue
7878
ver = guidsVersions[key]['ver']
@@ -111,7 +111,7 @@ def generateReadmeLines(currentData, guidsVersions):
111111

112112
def generateReadmeDeleted(guidsVersions):
113113
for item in guidsVersions.values():
114-
if item['removed'] != "False":
114+
if item['removed'] != "False":# need to add logic so that if removed is not found, it displays the message and moves on
115115
yield (f"| {item['ver']} | {item['removed']} | {item['name']} | {item['notes']} |"
116116
+ f" [{item['removed']}](https://github.com/oneapi-src/oneAPI-samples/releases/tag/{item['removed']})"
117117
+ (f" Path: {item['path']}" if 'path' in item else '')

.repo-tools/Docs_Automation/guids.json

Lines changed: 81 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
{
2+
"00BBDEF2-F34E-46EA-9D41-DF871CC7272F": {
3+
"guid": "00BBDEF2-F34E-46EA-9D41-DF871CC7272F",
4+
"name": "Autorun kernels",
5+
"notes": "-",
6+
"removed": "False",
7+
"ver": "2022.1.0"
8+
},
29
"028AE3ED-2896-4C56-9066-42AA5D5FA973": {
310
"guid": "028AE3ED-2896-4C56-9066-42AA5D5FA973",
411
"name": "Getting Started",
@@ -69,6 +76,13 @@
6976
"removed": "False",
7077
"ver": "2021.4.0"
7178
},
79+
"1de1f2df-f068-4d46-b280-4f2f8150c24e": {
80+
"guid": "1de1f2df-f068-4d46-b280-4f2f8150c24e",
81+
"name": "Numba DPPY Essentials training",
82+
"notes": "-",
83+
"removed": "False",
84+
"ver": "2022.1.0"
85+
},
7286
"1e00e2dd-ffe3-408f-a9ec-77e81532d75a": {
7387
"guid": "1e00e2dd-ffe3-408f-a9ec-77e81532d75a",
7488
"name": "Chapter 06 - Unified Shared Memory",
@@ -230,6 +244,18 @@
230244
"removed": "False",
231245
"ver": "2021.1.Gold"
232246
},
247+
"40C26D31-D553-4BD9-9E1D-63DDF352CB85": {
248+
"guid": "40C26D31-D553-4BD9-9E1D-63DDF352CB85",
249+
"name": "Intel oneAPI Rendering Toolkit OSPRay Getting Started",
250+
"removed": "False",
251+
"ver": "2021.4.0"
252+
},
253+
"41F82C06-A9FA-4521-B87A-8F7304CB6631": {
254+
"guid": "41F82C06-A9FA-4521-B87A-8F7304CB6631",
255+
"name": "Intel oneAPI Rendering Toolkit Open Image Denoise Getting Started",
256+
"removed": "False",
257+
"ver": "2021.4.0"
258+
},
233259
"42601abe-219f-425a-9170-073553c93979": {
234260
"guid": "42601abe-219f-425a-9170-073553c93979",
235261
"name": "Chapter 15 - Programming for GPUs",
@@ -265,6 +291,13 @@
265291
"removed": "False",
266292
"ver": "2021.1.Gold"
267293
},
294+
"4A9A5E59-D877-4FFF-A44C-0B96491840C0": {
295+
"guid": "4A9A5E59-D877-4FFF-A44C-0B96491840C0",
296+
"name": "Read-Only Cache",
297+
"notes": "-",
298+
"removed": "False",
299+
"ver": "2022.1.0"
300+
},
268301
"4B3FDDD8-64CF-4CF3-9387-26E34F021E24": {
269302
"guid": "4B3FDDD8-64CF-4CF3-9387-26E34F021E24",
270303
"name": "Debugger: Array Transform",
@@ -321,6 +354,13 @@
321354
"removed": "False",
322355
"ver": "2021.1.Gold"
323356
},
357+
"566433FF-0C04-4C99-A76E-B927F81872F8": {
358+
"guid": "566433FF-0C04-4C99-A76E-B927F81872F8",
359+
"name": "AC Int",
360+
"notes": "-",
361+
"removed": "False",
362+
"ver": "2022.1.0"
363+
},
324364
"58CF1ABA-5D08-40B7-ACC2-5CB904261413": {
325365
"guid": "58CF1ABA-5D08-40B7-ACC2-5CB904261413",
326366
"name": "Pipes",
@@ -482,6 +522,20 @@
482522
"removed": "False",
483523
"ver": "2021.1.Gold"
484524
},
525+
"77006CE8-2935-41C7-BA30-DF6EA07CD73A": {
526+
"guid": "77006CE8-2935-41C7-BA30-DF6EA07CD73A",
527+
"name": "DSP Control",
528+
"notes": "-",
529+
"removed": "False",
530+
"ver": "2022.1.0"
531+
},
532+
"79A181D7-D5AD-4D28-8508-3A04465265FB": {
533+
"guid": "79A181D7-D5AD-4D28-8508-3A04465265FB",
534+
"name": "Loop Fusion",
535+
"notes": "-",
536+
"removed": "False",
537+
"ver": "2022.1.0"
538+
},
485539
"7AC408C8-DF59-46AE-B970-178CF257F364": {
486540
"guid": "7AC408C8-DF59-46AE-B970-178CF257F364",
487541
"name": "Random Sampling Without Replacement",
@@ -510,10 +564,15 @@
510564
"removed": "False",
511565
"ver": "2021.4.0"
512566
},
567+
"80BB7E55-6FCA-491F-8541-E271324CF169": {
568+
"guid": "80BB7E55-6FCA-491F-8541-E271324CF169",
569+
"name": "Intel oneAPI Rendering Toolkit Open VKL Getting Started",
570+
"removed": "False",
571+
"ver": "2021.4.0"
572+
},
513573
"81B93386-B5EB-4998-B91B-3453263EC03E": {
514574
"guid": "81B93386-B5EB-4998-B91B-3453263EC03E",
515575
"name": "Intel\u00c2\u00ae Python Scikit-learn Extension Getting Started",
516-
"notes": "-",
517576
"removed": "False",
518577
"ver": "2021.4.0"
519578
},
@@ -559,6 +618,12 @@
559618
"removed": "False",
560619
"ver": "2021.1.Gold"
561620
},
621+
"87FA013D-0B19-45AE-BCD5-43412BE0A99F": {
622+
"guid": "87FA013D-0B19-45AE-BCD5-43412BE0A99F",
623+
"name": "Intel oneAPI Rendering Toolkit Embree Getting Started",
624+
"removed": "False",
625+
"ver": "2021.4.0"
626+
},
562627
"884439A5-0286-447B-9E6D-A7C22B61CED8": {
563628
"guid": "884439A5-0286-447B-9E6D-A7C22B61CED8",
564629
"name": "Triangular Loop",
@@ -594,6 +659,13 @@
594659
"removed": "False",
595660
"ver": "2021.1.Gold"
596661
},
662+
"8EC73D58-B010-4080-9785-B5D9DB13EF3F": {
663+
"guid": "8EC73D58-B010-4080-9785-B5D9DB13EF3F",
664+
"name": "Mem Channels",
665+
"notes": "-",
666+
"removed": "False",
667+
"ver": "2022.1.0"
668+
},
597669
"8cc4f36c-31e5-4964-b43f-cfb1221c4cb1": {
598670
"guid": "8cc4f36c-31e5-4964-b43f-cfb1221c4cb1",
599671
"name": "Chapter 11 - Vectors",
@@ -672,6 +744,13 @@
672744
"removed": "False",
673745
"ver": "2021.1.Gold"
674746
},
747+
"A42A1772-2448-4f67-AB28-4080FE47F9C1": {
748+
"guid": "A42A1772-2448-4f67-AB28-4080FE47F9C1",
749+
"name": "QRI",
750+
"notes": "-",
751+
"removed": "False",
752+
"ver": "2022.1.0"
753+
},
675754
"A544224A-B5C0-462C-95F6-7C266A1DB2EB": {
676755
"guid": "A544224A-B5C0-462C-95F6-7C266A1DB2EB",
677756
"name": "Digital Out",
@@ -1127,31 +1206,6 @@
11271206
"removed": "False",
11281207
"ver": "2021.1.Gold"
11291208
},
1130-
"81B93386-B5EB-4998-B91B-3453263EC03E": {
1131-
"guid": "81B93386-B5EB-4998-B91B-3453263EC03E",
1132-
"ver": "2021.4.0",
1133-
"name": "Intel® Python Scikit-learn Extension Getting Started"
1134-
},
1135-
"87FA013D-0B19-45AE-BCD5-43412BE0A99F" : {
1136-
"guid": "87FA013D-0B19-45AE-BCD5-43412BE0A99F",
1137-
"ver": "2021.4.0",
1138-
"name": "Intel oneAPI Rendering Toolkit Embree Getting Started"
1139-
},
1140-
"41F82C06-A9FA-4521-B87A-8F7304CB6631" : {
1141-
"guid": "41F82C06-A9FA-4521-B87A-8F7304CB6631",
1142-
"ver": "2021.4.0",
1143-
"name": "Intel oneAPI Rendering Toolkit Open Image Denoise Getting Started"
1144-
},
1145-
"80BB7E55-6FCA-491F-8541-E271324CF169" : {
1146-
"guid": "80BB7E55-6FCA-491F-8541-E271324CF169",
1147-
"ver": "2021.4.0",
1148-
"name": "Intel oneAPI Rendering Toolkit Open VKL Getting Started"
1149-
},
1150-
"40C26D31-D553-4BD9-9E1D-63DDF352CB85" : {
1151-
"guid": "40C26D31-D553-4BD9-9E1D-63DDF352CB85",
1152-
"ver": "2021.4.0",
1153-
"name": "Intel oneAPI Rendering Toolkit OSPRay Getting Started"
1154-
},
11551209
"f92e64c7-7a7c-4749-b421-9f7a9e120099": {
11561210
"guid": "f92e64c7-7a7c-4749-b421-9f7a9e120099",
11571211
"name": "Vectorize VecMatMult",
@@ -1166,4 +1220,4 @@
11661220
"removed": "False",
11671221
"ver": "2021.1.Gold"
11681222
}
1169-
}
1223+
}
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
Copyright Intel Corporation
2-
3-
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4-
5-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6-
7-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1+
Copyright Intel Corporation
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Copyright Intel Corporation
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Copyright Intel Corporation
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)