Skip to content

Commit 4ee81ef

Browse files
docstring update
1 parent f669beb commit 4ee81ef

File tree

3 files changed

+29
-3
lines changed

3 files changed

+29
-3
lines changed

pygenn/src/cudaBackendDocStrings.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,8 @@ R"doc(Create backend-specific runtime state object
105105
106106
runtime object)doc";
107107

108+
static const char *__doc_CodeGenerator_CUDA_Backend_genAllocateMemPreamble = R"doc()doc";
109+
108110
static const char *__doc_CodeGenerator_CUDA_Backend_genDefinitionsPreambleInternal = R"doc(Generate HIP/CUDA specific bits of definitions preamble)doc";
109111

110112
static const char *__doc_CodeGenerator_CUDA_Backend_genKernelDimensions = R"doc()doc";
@@ -137,6 +139,8 @@ static const char *__doc_CodeGenerator_CUDA_Backend_genPopProfilerRange = R"doc(
137139

138140
static const char *__doc_CodeGenerator_CUDA_Backend_genPushProfilerRange = R"doc(Generate code to push a profiler range marker)doc";
139141

142+
static const char *__doc_CodeGenerator_CUDA_Backend_getAllLanesShuffleMask = R"doc(Get mask to use for shuffle operations across all lanes)doc";
143+
140144
static const char *__doc_CodeGenerator_CUDA_Backend_getAtomic = R"doc(Get name of atomic operation)doc";
141145

142146
static const char *__doc_CodeGenerator_CUDA_Backend_getChosenCUDADevice = R"doc()doc";

pygenn/src/docStrings.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -392,8 +392,6 @@ R"doc(Create array of backend-specific population RNGs (if they are initialised
392392
393393
number of RNGs required)doc";
394394

395-
static const char *__doc_CodeGenerator_BackendCUDAHIP_genAllocateMemPreamble = R"doc()doc";
396-
397395
static const char *__doc_CodeGenerator_BackendCUDAHIP_genAssert = R"doc(On backends which support it, generate a runtime assert)doc";
398396

399397
static const char *__doc_CodeGenerator_BackendCUDAHIP_genCustomUpdate = R"doc()doc";
@@ -442,6 +440,8 @@ static const char *__doc_CodeGenerator_BackendCUDAHIP_genTimer = R"doc()doc";
442440

443441
static const char *__doc_CodeGenerator_BackendCUDAHIP_genWarpReduction = R"doc(Generate a warp reduction across getNumLanes lanes into lane 0)doc";
444442

443+
static const char *__doc_CodeGenerator_BackendCUDAHIP_getAllLanesShuffleMask = R"doc(Get mask to use for shuffle operations across all lanes)doc";
444+
445445
static const char *__doc_CodeGenerator_BackendCUDAHIP_getBlockID = R"doc(Get the ID of the current thread block)doc";
446446

447447
static const char *__doc_CodeGenerator_BackendCUDAHIP_getCCLPrefix = R"doc()doc";

pygenn/src/hipBackendDocStrings.h

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@ static const char *__doc_CodeGenerator_HIP_Backend_Backend = R"doc()doc";
2929

3030
static const char *__doc_CodeGenerator_HIP_Backend_areSharedMemAtomicsSlow = R"doc(On some older devices, shared memory atomics are actually slower than global memory atomics so should be avoided)doc";
3131

32+
static const char *__doc_CodeGenerator_HIP_Backend_buildPopulationRNGEnvironment = R"doc(Generate a preamble to add substitution name for population RNG)doc";
33+
34+
static const char *__doc_CodeGenerator_HIP_Backend_buildPopulationRNGEnvironment_2 = R"doc(Add $(_rng) to environment based on $(_rng_internal) field with any initialisers and destructors required)doc";
35+
3236
static const char *__doc_CodeGenerator_HIP_Backend_createArray =
3337
R"doc(Create backend-specific array object
3438

@@ -55,6 +59,8 @@ R"doc(Create backend-specific runtime state object
5559
5660
runtime object)doc";
5761

62+
static const char *__doc_CodeGenerator_HIP_Backend_genAllocateMemPreamble = R"doc()doc";
63+
5864
static const char *__doc_CodeGenerator_HIP_Backend_genDefinitionsPreambleInternal = R"doc(Generate HIP/CUDA specific bits of definitions preamble)doc";
5965

6066
static const char *__doc_CodeGenerator_HIP_Backend_genKernelDimensions = R"doc()doc";
@@ -77,6 +83,16 @@ static const char *__doc_CodeGenerator_HIP_Backend_genMakefileLinkRule = R"doc()
7783

7884
static const char *__doc_CodeGenerator_HIP_Backend_genMakefilePreamble = R"doc()doc";
7985

86+
static const char *__doc_CodeGenerator_HIP_Backend_genNMakefileCompileRule = R"doc()doc";
87+
88+
static const char *__doc_CodeGenerator_HIP_Backend_genNMakefileLinkRule = R"doc()doc";
89+
90+
static const char *__doc_CodeGenerator_HIP_Backend_genNMakefilePreamble = R"doc()doc";
91+
92+
static const char *__doc_CodeGenerator_HIP_Backend_genPopulationRNGInit = R"doc(For SIMT backends which initialize RNGs on device, initialize population RNG with specified seed and sequence)doc";
93+
94+
static const char *__doc_CodeGenerator_HIP_Backend_getAllLanesShuffleMask = R"doc(Get mask to use for shuffle operations across all lanes)doc";
95+
8096
static const char *__doc_CodeGenerator_HIP_Backend_getAtomic = R"doc(Get name of atomic operation)doc";
8197

8298
static const char *__doc_CodeGenerator_HIP_Backend_getChosenDeviceID = R"doc()doc";
@@ -97,6 +113,8 @@ This is typically used for warp-shuffle algorithms)doc";
97113

98114
static const char *__doc_CodeGenerator_HIP_Backend_getPopulationRNGInternalType = R"doc(Get internal type population RNG gets loaded into)doc";
99115

116+
static const char *__doc_CodeGenerator_HIP_Backend_getPopulationRNGType = R"doc(Get type of population RNG)doc";
117+
100118
static const char *__doc_CodeGenerator_HIP_Backend_getRNGFunctions = R"doc(Get library of RNG functions to use)doc";
101119

102120
static const char *__doc_CodeGenerator_HIP_Backend_getRuntimeVersion = R"doc()doc";
@@ -107,6 +125,8 @@ static const char *__doc_CodeGenerator_HIP_Backend_m_ChosenDeviceID = R"doc()doc
107125

108126
static const char *__doc_CodeGenerator_HIP_Backend_m_RuntimeVersion = R"doc()doc";
109127

128+
static const char *__doc_CodeGenerator_HIP_Backend_shouldUseNMakeBuildSystem = R"doc()doc";
129+
110130
static const char *__doc_CodeGenerator_HIP_Optimiser_createBackend = R"doc()doc";
111131

112132
static const char *__doc_CodeGenerator_HIP_Preferences = R"doc(Preferences for HIP backend)doc";
@@ -119,7 +139,9 @@ Each of the four modules which includes CUDA headers(neuronUpdate, synapseUpdate
119139
Takes 72 bytes of constant memory for a lookup table used by cuRAND. If your application requires
120140
additional constant cache, increase this)doc";
121141

122-
static const char *__doc_CodeGenerator_HIP_Preferences_manualBlockSizes = R"doc(If block size select method is set to BlockSizeSelect::MANUAL, block size to use for each kernel)doc";
142+
static const char *__doc_CodeGenerator_HIP_Preferences_manualBlockSizes =
143+
R"doc(If block size select method is set to BlockSizeSelect::MANUAL, block size to use for each kernel
144+
These default to zero which signals the HIP backend to replace them with the device warp size.)doc";
123145

124146
static const char *__doc_CodeGenerator_HIP_Preferences_manualDeviceID = R"doc(If device select method is set to DeviceSelect::MANUAL, id of device to use)doc";
125147

0 commit comments

Comments
 (0)