feat: generate docs from build file and source #89
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
danieldk
reviewed
Mar 24, 2025
scripts/gen-docs.py
Outdated
Comment on lines
110
to
118
| # Also collect all other source files | ||
| for ext in [".cu", ".h", ".cpp", ".cuh"]: | ||
| extra_files = [] | ||
| for p in Path(project_path).glob(f"**/*{ext}"): | ||
| # avoid adding `torch-ext` files | ||
| if "torch-ext" in str(p): | ||
| continue | ||
| if p not in source_files: | ||
| extra_files.append(p) |
There was a problem hiding this comment.
Is there any reason for doing this? As far as kernel-builder is concerned, unspecified source files do not exist (are not added to the sandbox).
4 tasks
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a new script that generates markdown documents for each kernel based on the
build.tomland the supplied source code.TODO
Examples
this creates a new doc located here
examples/relu/docs/relu.md(contents shown below *updated)
reluDocumentationTable of Contents
Project Overview
relu is a CUDA kernel project.
Build Configuration
Kernels
activation
CUDA Capabilities:
['7.0', '7.2', '7.5', '8.0', '8.6', '8.7', '8.9', '9.0']Source Files:
relu_kernel/relu.cuDependencies:
torchoperations
relu(Tensor! out, Tensor input) -> ()defined