search

scikit-learn-contrib / scikit-learn-extra

scikit-learn contrib estimators
https://scikit-learn-extra.readthedocs.io
BSD 3-Clause "New" or "Revised" License
186 stars 42 forks source link

Citation? #133

Open NimaSarajpoor opened 2 years ago

NimaSarajpoor commented 2 years ago

I am trying to find a section on this repo that tells me how to cite scikit-learn-extra. I couldn't find anything. Could you please help me with this?

chkoar commented 2 years ago

Good question. This is something that should be discussed. I suppose that a generic approach would be something like the following:

@online{scikit-learn-extra,
  title={scikit-learn-extra: a Python module for machine learning that extends scikit-learn},
  author={The scikit-learn-extra development team},
  year={2020},
  publisher={GitHub},
  url={https://github.com/scikit-learn-contrib/scikit-learn-extra},
}

@scikit-learn-contrib/scikit-learn-extra citing the code as a frozen artifact, zenodo could be an option. On the other hand the package might be eligible for an open source software journal like the Journal of Open Source Software.

rth commented 2 years ago

On the short term, +1 to add Zenodo, which would generate a citation DOI

We could indeed write a short paper, but maybe in a year or so when there are more algorithms included ?

chkoar commented 2 years ago

Agreed.

NimaSarajpoor commented 2 years ago

Thanks everyone. Appreciate your input.

For now, I will use the BibTeX format provided by @chkoar.