|
| 1 | +--- |
| 2 | +#### Blog Post Template #### |
| 3 | + |
| 4 | +#### Post Information #### |
| 5 | +title: "Note on Inline Authorship Information in scikit-learn" |
| 6 | +date: May 4, 2024 |
| 7 | + |
| 8 | +#### Post Category and Tags #### |
| 9 | +# Format in titlecase without dashes (Ex. "Open Source" instead of "open-source") |
| 10 | +categories: |
| 11 | + - Updates |
| 12 | +tags: |
| 13 | + - Open Source |
| 14 | + - Machine Learning |
| 15 | + - License |
| 16 | + |
| 17 | +#### Featured Image #### |
| 18 | +featured-image: BSD_watermark.svg |
| 19 | + |
| 20 | +#### Author Info #### |
| 21 | +# Can accomodate multiple authors |
| 22 | +# Add SQUARE Author Image to /assets/images/author_images/ folder |
| 23 | +postauthors: |
| 24 | + - name: Adrin Jalali |
| 25 | + website: https://adrin.info/ |
| 26 | + image: adrin-jalali.jpeg |
| 27 | +--- |
| 28 | +<div> |
| 29 | + <img src="/assets/images/posts_images/{{ page.featured-image }}" alt=""> |
| 30 | + {% include postauthor.html %} |
| 31 | +</div> |
| 32 | + |
| 33 | +Historically, scikit-learn's files have included authorship information similar |
| 34 | +to the following format: |
| 35 | + |
| 36 | +```python |
| 37 | +# Authors: Author1, Author2, ... |
| 38 | +# License: BSD 3 clause |
| 39 | +``` |
| 40 | + |
| 41 | +However, after a series of discussions which you can see in detail in [this |
| 42 | +issue]( https://github.com/scikit-learn/scikit-learn/pull/28799), could list |
| 43 | +the following caveats to the status quo: |
| 44 | + |
| 45 | +- Authorship information was not up-to-date and in most cases, but not always, |
| 46 | + reflect the original authors of the file; |
| 47 | +- It was unfair to all other contributors who have been contributing to the |
| 48 | + code-base; |
| 49 | +- One can check the real authors and the history of the authors of any part of |
| 50 | + the code-base using `git blame` and other `git` tools. |
| 51 | + |
| 52 | +Therefore we came to the conclusion to change all inline license information to |
| 53 | +the following: |
| 54 | + |
| 55 | +```python |
| 56 | +# Authors: The scikit-learn developers |
| 57 | +# License: BSD-3-Clause |
| 58 | +``` |
| 59 | + |
| 60 | +The change is to happen gradually in the coming months after April 2024. |
0 commit comments