heat icon indicating copy to clipboard operation
heat copied to clipboard

Replace scattered scikit-learn references with central BSD-3 clause reference

Open Markus-Goetz opened this issue 4 years ago • 9 comments

Feature functionality Remove the scattered references to scikit learn (in the docstrings) and replace it with a BSD-3 clause reference.

Markus-Goetz avatar Apr 06 '20 19:04 Markus-Goetz

Was this closed by #757 ?

ClaudiaComito avatar May 26 '21 05:05 ClaudiaComito

I am not 100% sure, but it is likely. i think this can be closed for now under this assumption.

If we see something in the docs then we can make something short to remove it

coquelin77 avatar May 26 '21 06:05 coquelin77

It was not done as part of the PR. It is still an open todo

Markus-Goetz avatar May 26 '21 06:05 Markus-Goetz

@Markus-Goetz can you add a link? What is this supposed to look like?

ClaudiaComito avatar Apr 04 '22 08:04 ClaudiaComito

It was not closed by #757. At the moment we state in individual algorithms that we have used/adapted/been inspired by code of other libraries. It would be generally good to acknowledge this and particularly we are requested to do so if the used libraries are for example licensed under BSD-2/3 (see here https://en.wikipedia.org/wiki/BSD_licenses).

I am not sure how to do this best. Perhaps a high-level acknowledgment file and/or a remark in the docs, other options of your choosing

Markus-Goetz avatar Apr 06 '22 08:04 Markus-Goetz

Reasonable.

Reviewed within #1109

mrfh92 avatar Aug 21 '23 10:08 mrfh92

just a comment we could think about: this may be combined with collecting other literature/references of interest at a central place instead of scattering them.

mrfh92 avatar Aug 21 '23 10:08 mrfh92

~~Here's what needs to be done (see PyTorch/third_party):~~

  • [ ] ~~create a directory third_party in the root directory of Heat's repository~~
  • [ ] ~~in third_party, create git submodules for each reference library (see https://git-scm.com/book/en/v2/Git-Tools-Submodules)~~

Misunderstanding, apologies

ClaudiaComito avatar Oct 09 '23 09:10 ClaudiaComito