Skip to content

Commit 7d85b0e

Browse files
authored
init update, including build/launch options doc auto generation (#2080)
* init update, including build/launch options doc auto generation features doc merge cpu and gpu, add getting started fine tune amp update installation guide update advanced_configuration.md correct hyperlink, add images for cpu,gpu merge trim spaces deprecate auto channels last apis
1 parent ac8b012 commit 7d85b0e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+2885
-789
lines changed

README.md

Lines changed: 50 additions & 583 deletions
Large diffs are not rendered by default.

csrc/gpu/utils/Settings.cpp

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,35 +12,41 @@ namespace xpu {
1212
namespace dpcpp {
1313

1414
/*
15+
* [Keep the format for automatic doc generation.]
1516
* All available launch options for IPEX
16-
*
17-
* IPEX_VERBOSE:
18-
* Default = 0, Set verbose level with synchronization execution mode
19-
* IPEX_FP32_MATH_MODE:
20-
* Default = 0, Set values for FP32 math mode (0: FP32, 1: TF32, 2: BF32)
21-
*
17+
* ==========ALL==========
18+
* IPEX_VERBOSE:
19+
* Default = 0 | Set verbose level with synchronization execution mode
20+
* IPEX_FP32_MATH_MODE:
21+
* Default = 0 | Set values for FP32 math mode (0: FP32, 1: TF32, 2: BF32)
22+
* ==========ALL==========
2223
*
2324
* XPU ONLY optionos:
24-
*
25-
* IPEX_XPU_BACKEND:
26-
* Default = 0 (GPU), Set XPU_BACKEND as global IPEX backend
25+
* ==========GPU==========
2726
* IPEX_XPU_SYNC_MODE:
28-
* Default = 0, Set 1 to enforce synchronization execution mode
27+
* Default = 0 | Set 1 to enforce synchronization execution mode
2928
* IPEX_TILE_AS_DEVICE:
30-
* Default = 1, Set 0 to disable tile partition and map per root device
31-
*
29+
* Default = 1 | Set 0 to disable tile partition and map per root device
30+
* ==========GPU==========
3231
*
3332
* EXPERIMENTAL options:
34-
*
33+
* ==========EXP==========
34+
* IPEX_SIMPLE_TRACE:
35+
* Default = 0 | Set 1 to enable simple trace for all operators*
36+
* ==========EXP==========
37+
38+
* Internal options:
39+
* ==========INT==========
40+
* IPEX_XPU_BACKEND:
41+
* Default = 0 (GPU) | Set XPU_BACKEND as global IPEX backend
3542
* IPEX_SHOW_OPTION:
36-
* Default = 0, Set 1 to show all launch option values
43+
* Default = 0 | Set 1 to show all launch option values
3744
* IPEX_XPU_ONEDNN_LAYOUT:
38-
* Default = 0, Set 1 to enable onednn specific layouts
45+
* Default = 0 | Set 1 to enable onednn specific layouts
3946
* IPEX_FORCE_ONEDNN_PRIMITIVE:
40-
* Default = 0, Set 1 to force oneDNN primitive solution for below
47+
* Default = 0 | Set 1 to force oneDNN primitive solution for below
4148
* operators: GRU
42-
* IPEX_SIMPLE_TRACE:
43-
* Default = 0, Set 1 to enable simple trace for all operators*
49+
* ==========INT==========
4450
*/
4551

4652
static std::mutex s_mutex;

docs/Doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -791,7 +791,7 @@ WARN_LOGFILE =
791791
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
792792
# Note: If this tag is empty the current directory is searched.
793793

794-
INPUT = ../csrc/include/xpu
794+
INPUT = ../csrc/gpu/include/xpu
795795

796796
# This tag can be used to specify the character encoding of the source files
797797
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
28.5 KB
Loading
103 KB
Loading
212 KB
Loading
385 KB
Loading
308 KB
Loading
227 KB
Loading
365 KB
Loading

0 commit comments

Comments
 (0)