DOC Add basic example gallery infrastructure and two examples #5845
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
dantegd
reviewed
Apr 16, 2024
| Example gallery | ||
| =============== | ||
|
|
||
| Below is a gallery of examples showing how to use cuml. |
There was a problem hiding this comment.
Suggested change
| Below is a gallery of examples showing how to use cuml. | |
| Below is a gallery of examples showing how to use cuML. |
| @@ -0,0 +1,128 @@ | |||
| """ | |||
There was a problem hiding this comment.
Good point. I was wondering how to deal with licensing and attribution. My best guess so far would be something like the following. Though the BSD3 license says we also need to reproduce the 3 clauses and disclaimer. But that would add excessive amount of text to the top of each file. Maybe we can deal with it in some other way? Is there prior art somewhere?
# BSD 3-Clause License
#
# Copyright (c) 2007-2024 The scikit-learn developers.
# All rights reserved.
#
#
# Copyright (c) 2024, NVIDIA CORPORATION.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
| @@ -0,0 +1,247 @@ | |||
| # -*- coding: utf-8 -*- | |||
| @@ -0,0 +1,205 @@ | |||
| """ | |||
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.
I have been looking at the scikit-learn gallery and attempting to "translate" examples from it to use RAPIDS projects where possible. Mostly this is an exercise in learning how such transformations look, what changes are common, etc
I thought it could be nice to add these examples to the cuml gallery, realised there was none and hence this PR.
It adds basic infrastructure to make a gallery work. The gallery is a new section in the documentation and examples are cross linked from the API docs of a class (at the bottom of
KMeansit shows a thumbnail for the example that usesKMeans).What do people think of this?
It would be ideal to somehow be able to highlight the differences between the "cuml" and "scikit-learn" versions of an example. That way readers could more easily see the bits that are relevant to "I have CPU code and want to move to GPU". However, I don't know how to do that :D
I plan to translate a few more examples, but not all of them. I think getting this merged even with a "slim" gallery to start would be good, that way others could also add examples (instead of having one mega PR that is essentially blocked on one person and unreviewable)
Marking as draft for now to see what the CI robots say and what needs fixing up for the docs preview.