Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Documentation: add example python api call for ExplainPlan.explainPotentialGpuPlan [skip ci] #4965

Merged
merged 8 commits into from
Mar 17, 2022
Merged

Documentation: add example python api call for ExplainPlan.explainPotentialGpuPlan [skip ci] #4965

merged 8 commits into from
Mar 17, 2022

Conversation

tgravescs
Copy link
Collaborator

fixes #4745

@tgravescs tgravescs added the documentation Improvements or additions to documentation label Mar 16, 2022
@tgravescs tgravescs added this to the Feb 28 - Mar 18 milestone Mar 16, 2022
@tgravescs tgravescs self-assigned this Mar 16, 2022
@tgravescs tgravescs changed the title Documentation: add example python api call for ExplainPlan.explainPotentialGpuPlan Documentation: add example python api call for ExplainPlan.explainPotentialGpuPlan [skip ci] Mar 16, 2022
@tgravescs
Copy link
Collaborator Author

build

@tgravescs
sign off
0ed97d0 
Signed-off-by: Thomas Graves <tgraves@nvidia.com>
@tgravescs
Copy link
Collaborator Author

build

jlowe
jlowe reviewed Mar 16, 2022
View reviewed changes
docs/get-started/getting-started-workload-qualification.md Outdated
```
- First parameter, `df` is the Spark DataFrame to get the query plan from.
- Second parameter, `ALL` returns all the explain data, you can change to `NOT_ON_GPU` to return just what
does not work on the GPU. The Scala API, ALL is the default when second parameter is not specified.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"The Scala API," is a bit confusing here, was it intended to say "For the Scala API," or was this supposed to be in a separate section like "Python API:" above?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

really I just want the java doc of this function which we don't publish so I changed this to just have a function documentation section

@tgravescs
Copy link
Collaborator Author

IO need to fix a few formatting things

@tgravescs
Copy link
Collaborator Author

ok formatting is fixed

@tgravescs
Copy link
Collaborator Author

build

@tgravescs @jlowe
Update docs/get-started/getting-started-workload-qualification.md
3017ae4 
Co-authored-by: Jason Lowe <jlowe@nvidia.com>
@tgravescs
Copy link
Collaborator Author

build

@tgravescs tgravescs merged commit 3e62aac into NVIDIA:branch-22.04 Mar 17, 2022
@tgravescs tgravescs deleted the docpythonexplain branch March 17, 2022 13:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jlowe jlowe jlowe approved these changes

Assignees

@tgravescs tgravescs

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
Feb 28 - Mar 18
Development

Successfully merging this pull request may close these issues.

[DOC] add example python api call for ExplainPlan.explainPotentialGpuPlan
2 participants
@tgravescs @jlowe