-
Notifications
You must be signed in to change notification settings - Fork 300
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
adding cugraph-ops #3488
adding cugraph-ops #3488
Conversation
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.
Just need to rename pytorch.rst.txt
-> pytorch.rst
. LGTM otherwise.
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.
Like @tingyu66 pointed out, the pytorch file naming is incorrect.
Additionally, I'm not sure what the plan is, but the C++ API docs are not found here: is the plan to just not add them at all, add them in a later PR, or should they be added immediately here?
:maxdepth: 2 | ||
:caption: API Documentation | ||
|
||
graph_types |
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.
should also add pytorch here at the top IMO (just noticed that our own docs have them at the end, but pytorch is the main API for end-users so this should be the first thing to see)
graph_types | |
pytorch | |
graph_types |
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.
Adding the C++ API is an upcoming step. Working on covering from Doxogen to Sphinx. Once I have the process setup for the other cugraph C code, then I'll be rolling in cugraph-ops.
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.
I believe you now added the pytorch entry twice, as well as not adding it at the top as suggested above.
Let's just remove one of these instances, or completely remove this if it doesn't pass CI
I was getting an error in the pytorch.rst file and left it out so that I could get the basic framework in place and verify that and external python package could be in the docs |
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.
👍
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.
Overall looks good to me. I do think it's a little odd to add docs to components that live in another repo here, but I can't think of a better solution now.
I have been pondering how to create a unified docs page that brings in all the various sections. Most examples from other products use a central repo that clones all the other repos into one so that docs can be created. I'm trying to avoid that. Yes it is odd to have stuff from another repo - but it all falls under Graph |
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 good to me
/merge |
The goal is to have a unified docs area for all graph work. This PR is the first step in getting cugraph-ops included in the main graph doc area