Documentation effort - Githubissues

miguel-petersen commented 1 year ago

Code is great, when people can understand it. So, let's make an effort to improve documentation.

The following list will be extended over time:

[ ] Instruction set exposed
[ ] Resource tokens / PRMT
[ ] PRMT descriptor data uploading
[ ] Shader program hosts
[ ] Shader data hosts
[ ] User command buffers / hooking
[ ] SVOX
[ ] Networking architecture (pretty important one)
[ ] SPIRV compilation passes (write-up)
[ ] DXIL compilation passes (write-up), many pages
[ ] Versioning system
[ ] Chunked messages
[ ] Export streaming (multiple buffers)
[ ] Shader instrumentation propagation / keys
[ ] Instrumentation strategy (block vistation, nested instrumentation, etc...)
[ ] Basic block instruction memory (not a simple thing)
[ ] Plugin setup (everything is written as a plugin really)
[ ] DX12 descriptor injection
[ ] DX12 bootstrapping
[ ] DX12 root register mapping
[ ] DX12 gpu address tracking
[ ] Vulkan SE descriptor set mapping and update-after-bind stuff
[ ] Vulkan / DX12 code generation
[ ] Patch command list
[ ] Vulkan PRMT heap emulation
[ ] Startup environments

Feel free to add as you see fit.

miguel-petersen commented 1 year ago

@aurolou I am aware that documentation is an issue, please feel free to add as much as you see fit.

aurolou commented 1 year ago

I started to do some documentation on the documentation branch. Right now it's end-user focused and incomplete, but it's on my TODO list to finish.

miguel-petersen commented 1 year ago

That's a great point.

Ocasio-J commented 5 months ago

Documentation can list supported GPU vendors? Or is GPUReshape agnostic to that?

GPUOpen says:

To use GPU Reshape, if you are using an AMD GPU, please make sure you have the AMD Software: Adrenalin Edition™ application software drivers 23.10.2 or newer installed.

Despite the "if", it at least makes one wonder which other vendors are supported.

miguel-petersen commented 5 months ago

Hi @Ocasio-J ,

GPU Reshape is agnostic to the vendor, as long as it supports either DX12 or Vulkan.

A little further down the product page it details the vendor support, though, I suppose that could be moved up to clarify things.

I'll bring it up on my end. Thanks!

GPUOpen-Tools / GPU-Reshape

Documentation effort #12