Much Anticipated Camp Docs #158
Conversation
Added RTD template and sphinx project settings and doxygen instructions
Some are still under construction, or unfinished.
kab163
requested review from
adayton1,
davidbeckingsale,
rhornung67,
long58 and
trws
|
Awesome!!!! |
…nto kab163/long58/camp-docs
|
I added a couple more pages that I had been working on, as well as fixed the issues in the pages that I wrote that @trws pointed out. |
| ... | ||
| auto resource = camp::resources::Resource{resource_type{}}; // Create a (Generic) Camp resource | ||
| my_kernel<<<NUM_BLOCKS, THREADS_PER_BLOCK>>>(my_data); // Do some work on the device | ||
| resource.get_event().wait(); // Use the resource to synchronize the device after the kernel |
There was a problem hiding this comment.
I don't believe this is not guaranteed to work because the kernel and the resource are not guaranteed to be associated with the same GPU stream.
To guarantee correctness, you would need to launch the kernel like this:
my_kernel<<<NUM_BLOCKS, THREADS_PER_BLOCK, 0, resource.get_stream()>>>(my_data);
The zero arg indicates the amount of shared memory to use.
There was a problem hiding this comment.
I think I know what you mean, but technically you used 3 negatives in that first sentence :p
There was a problem hiding this comment.
Sorry I was not clear. You will need to pass stream from the resource as the fourth arg in the <<<...>>> construct to guarantee that you will be waiting on the correct event as in the kernel launch syntax I wrote.
docs/doxygen/Doxyfile
Outdated
There was a problem hiding this comment.
This file appears to be unused. blt_add_doxygen_target uses CMake's configure_file() to read Doxyfile.in, perform string substitution, and write Doxyfile in the build directory. (extern/blt/cmake/SetupDocs.cmake:30)
It does 😄 |
Co-authored-by: Rich Hornung <[email protected]>
I am oh so tired of Camp having zero docs - let's change that!
Building upon Zoe's documentation...
See generated docs here: https://camp.readthedocs.io/en/kab163-long58-camp-docs/index.html