-
Notifications
You must be signed in to change notification settings - Fork 540
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[REVIEW] Improve Documentation Examples and Source Linking #2541
[REVIEW] Improve Documentation Examples and Source Linking #2541
Conversation
Please update the changelog in order to start CI tests. View the gpuCI docs here. |
PR is ready to review. Depends on PR #2638 which has been merged into this branch already (so some of the diff files will be due to that PR). Be sure to look at |
@JohnZed This should be good for review pending CI. I added the copyright messages as we discussed to the 3 new files. Not sure if we should add the NV copyright as well. Let me know and I can make the change quickly. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! We should get a quick @rapidsai/ops-codeowners signoff as well. It wasn't triggered by these files, but the ops team drives much of the doc publishing, so let's loop them in.
rerun tests |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
confirmed source code link locally. awesome change! 🔥 thanks for the heads up @JohnZed
Adding some features from sklearn's documentation into cuml. This includes the ability to toggle the output of examples directly in the HTML documentation and adding source links for each class/method.
In order to get the source linking to work, Cython needed to be compiled with
binding=True
for the compiler directives. See this link for an explanation: https://opendreamkit.org/2017/06/09/CythonSphinx/Creating this WIP PR to evaluate any performance regressions since
binding=True
changes how Cython calls pyx functions.@dantegd Would like to discuss the Cython build process to determine the best way to include
binding=True
in the current system. I took some inspiration from this Cython issue and its working relatively well.. Would appreciate any feedback since it would be a large change to the build system.