search

Sm00thix / IKPLS

Fast CPU and GPU Python implementations of Improved Kernel PLS by Dayal and MacGregor (1997) and Shortcutting Cross-Validation by Engstrøm (2024).
https://ikpls.readthedocs.io/en/latest/
Apache License 2.0
8 stars 3 forks source link

Changes to paper.md introduction and first section in README #29

Closed Sm00thix closed 2 months ago

Sm00thix commented 3 months ago

Quoting @basileMarchand from the review at JOSS:

In the JOSS paper, it would be good in my opinion to have a more "simplified" introduction in the summary so that a less experienced reader can easily understand what need the package is addressing. Also, the first paragraph of the README (which is also the first paragraph of the documentation) should be made more engaging to catch the attention of readers who might be searching without really knowing what they need. This would help attract more users and build a more diverse community.

Sm00thix commented 3 months ago

Hi @basileMarchand,

I have done my best to implement the requested changes. Please, let me know what you think.

basileMarchand commented 2 months ago

Hi @Sm00thix,

thank you for the work on rewriting the introduction. I think it makes the paper more engaging now because it's more accessible to people who are not specialists (they can understand what they just came across). I believe that even for you, for the dissemination of your package, this will help reach more people. Just one last suggestion, I think you could take the first 2-3 sentences of the JOSS paper summary and integrate them directly into the README, in the first section, so that anyone who comes across the IKPLS documentation or repository can immediately understand what they have found.

Sm00thix commented 2 months ago

Hi @basileMarchand!

Thank you for your suggestions and aid in improving the reach of ikpls. I have incorporated your last suggestion in https://github.com/Sm00thix/IKPLS/commit/36b10aedb42de483d89c3b9adf24723840401439. :-)

basileMarchand commented 2 months ago

It's perfect! In my opinion, documentation is more attractive this way.

Sm00thix commented 2 months ago

Hi @basileMarchand,

Thank you! I agree. I will close this issue :-)