Update API reference and examples in docs #561
Merged
Conversation
This file contains 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
charlesbluca
added
2 - In Progress
Codecov Report
@@ Coverage Diff @@
## branch-0.20 #561 +/- ##
===============================================
+ Coverage 61.06% 62.07% +1.00%
===============================================
Files 22 22
Lines 2571 2634 +63
===============================================
+ Hits 1570 1635 +65
+ Misses 1001 999 -2
Continue to review full report at Codecov.
|
pentschev
reviewed
Apr 6, 2021
There was a problem hiding this comment.
Thanks @charlesbluca for working on this, I added some comments.
charlesbluca
commented
Apr 6, 2021
pentschev
reviewed
Apr 7, 2021
charlesbluca
commented
Apr 7, 2021
rapids-bot bot
pushed a commit
that referenced
this pull request
Apr 9, 2021
Based on some discussions in #561, this PR removes some kwargs from `LocalCUDACluster` that may not be needed: - `processes` doesn't have any impact on its construction (other than throwing a `ValueError` if it's set false); this should be safe to remove altogether - `data` is pretty complex and it isn't commonly specified, so it can be removed from the named arguments and accessed through the `kwargs` object if it is specified Authors: - Charles Blackmon-Luca (https://github.com/charlesbluca) Approvers: - Peter Andreas Entschev (https://github.com/pentschev) URL: #562
pentschev
reviewed
Apr 9, 2021
|
I think this PR is at a good closing point - the API reference is updated, the installation + quickstart is fleshed out a bit more, and there are clear minimal examples of using LocalCUDACluster and
|
pentschev
reviewed
Apr 9, 2021
charlesbluca
added
3 - Ready for Review
charlesbluca
commented
Apr 12, 2021
| "--dashboard-prefix", | ||
| type=str, | ||
| default=None, | ||
| help="""Prefix for the dashboard. Can be a string (like ...) or ``None`` for no |
There was a problem hiding this comment.
Do we know what dashboard prefix input should look like?
There was a problem hiding this comment.
I'm not sure, maybe @jacobtomlinson can help with this one.
pentschev
approved these changes
Apr 12, 2021
|
@gpucibot merge |
This was referenced Apr 13, 2021
rapids-bot bot
pushed a commit
that referenced
this pull request
Apr 19, 2021
Adds sphinx-click to the Conda environment used by RTD, which is necessary now because of #561. Fixes doc builds, which are currently failing. Authors: - Charles Blackmon-Luca (https://github.com/charlesbluca) Approvers: - https://github.com/jakirkham - Jordan Jacobelli (https://github.com/Ethyling) URL: #578
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
Addresses #554; I tried to tidy up the installation/specializations/quickstart pages so that some of the more technical stuff could go into some published examples, and probably a new page discussing configuration of LocalCUDACluster /
dask-cuda-worker.Also added
sphinx-clickto the dependencies so we can more easily document any changes todask-cuda-worker(#560) - I would also like to get the docstrings for the CLI, LocalCUDACluster, andinitiailize()up to date and more concise if possible.