-
-
Notifications
You must be signed in to change notification settings - Fork 34
SLEP024 Guideline for external posts on scikit-learn blog #92
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
Draft
glemaitre
wants to merge
3
commits into
scikit-learn:main
Choose a base branch
from
glemaitre:slep_024
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,6 +25,7 @@ | |
slep012/proposal | ||
slep017/proposal | ||
slep019/proposal | ||
slep024/proposal | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
.. _slep_024: | ||
|
||
=========================================================================== | ||
SLEP024: Guideline for external contributions to the scikit-learn blog post | ||
=========================================================================== | ||
|
||
:Author: Guillaume Lemaitre, François Goupil | ||
:Status: Draft | ||
:Type: Standards Track | ||
:Created: 2024-08-09 | ||
|
||
Abstract | ||
-------- | ||
|
||
This SLEP proposes some guidelines for writing and reviewing external contributions | ||
to the scikit-learn blog post. | ||
|
||
Detailed description | ||
-------------------- | ||
|
||
Scikit-learn has a blog post available at the following URL: | ||
https://blog.scikit-learn.org/. Since its origin, the blog post is used to relay | ||
information related to diverse subject such as sprints, interviews of contributors, | ||
collaborations, and technical content. | ||
|
||
When it comes to technical content, up to now, the content is only limited to the | ||
scikit-learn library. However, the scikit-learn community is going beyond the | ||
library itself and had developed compatible tools for years. As an example, the | ||
scikit-learn-contrib repository [2]_ is hosting a collection of tools which are not | ||
part of the main library but are still compatible with scikit-learn. | ||
|
||
This SLEP proposes to extend the scope of the technical content of the blog post to | ||
accept contributions in link with the scikit-learn ecosystem but not limited to the | ||
scikit-learn library itself. However, it is necessary to define some guidelines to | ||
manage expectations of contributors and readers. | ||
|
||
Here, we define the guidelines for external contributions that should be used to | ||
write and review external contributions to the scikit-learn blog post. | ||
|
||
Guidelines | ||
---------- | ||
|
||
TODO | ||
|
||
Discussion | ||
---------- | ||
|
||
TODO | ||
|
||
References and Footnotes | ||
------------------------ | ||
|
||
.. [1] Each SLEP must either be explicitly labeled as placed in the public | ||
domain (see this SLEP as an example) or licensed under the `Open | ||
Publication License`_. | ||
|
||
.. [2] `scikit-learn-contrib repository <https://github.com/scikit-learn-contrib>`__ | ||
|
||
.. _Open Publication License: https://www.opencontent.org/openpub/ | ||
|
||
Copyright | ||
--------- | ||
|
||
This document has been placed in the public domain. [1]_ |
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.
Uh oh!
There was an error while loading. Please reload this page.
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.
Thank you for opening the discussion.
If I can interject, some content is also exposed on external website but only linked on the blog post. This is for instance the case of the series on performance improvements.
I think it would be better to have this part of scikit-learn's blog post directly.
This was not done originally because of lack of time and for convenience (it was easy for me to publish it on my website and to iterate on it), but I do no mean to be the sole owner of the knowledge shared there.
Should such external content be discussed as part of this SLEP?
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.
You are faster than me writing the SLEP :).
For this particular case, this is not even a question since this already linked to some internal of scikit-learn. So it would go to facto in the scikit-learn blog if you ask me.
But let's imagine that this is a topic that is related to scikit-learn but somehow outside of the library itself. Then, I would consider this case as part of the SLEP. The guidelines should answer to some questions with some extend, notably if this is eligible for inclusion.
Note, that my first thought here with this SLEP was more on: someone has a shiny compatible package and search some visibility; is it possible to advertise it and if so, what are the couple of requirements from our side.
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.
OK, I was unsure my remark was relevant with regards to the subject of this SLEP (and it is not based on your remark).
Should I open an issue or PRs directly to integrate its content in scikit-learn's blog?
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.
Yep I would find it relevant.
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 just have opened scikit-learn/blog#191.