Nothing Special   »   [go: up one dir, main page]

Skip to content
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

[REVIEW]: mlpack 4: a fast, header-only C++ machine learning library #5026

Closed
editorialbot opened this issue Dec 23, 2022 · 70 comments
Closed
Assignees
Labels
accepted C++ CMake published Papers published in JOSS recommend-accept Papers recommended for acceptance in JOSS. review Shell Track: 5 (DSAIS) Data Science, Artificial Intelligence, and Machine Learning

Comments

@editorialbot
Copy link
Collaborator
editorialbot commented Dec 23, 2022

Submitting author: @rcurtin (Ryan Curtin)
Repository: https://github.com/mlpack/mlpack
Branch with paper.md (empty if default branch): mlpack4_joss
Version: 4.0.1
Editor: @osorensen
Reviewers: @sandeep-ps, @zhangjy-ge
Archive: 10.5281/zenodo.7587252

Status

status

Status badge code:

HTML: <a href="https://joss.theoj.org/papers/35ade482a14780ee52bad48fcc5f2be5"><img src="https://joss.theoj.org/papers/35ade482a14780ee52bad48fcc5f2be5/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/35ade482a14780ee52bad48fcc5f2be5/status.svg)](https://joss.theoj.org/papers/35ade482a14780ee52bad48fcc5f2be5)

Reviewers and authors:

Please avoid lengthy details of difficulties in the review thread. Instead, please create a new issue in the target repository and link to those issues (especially acceptance-blockers) by leaving comments in the review thread below. (For completists: if the target issue tracker is also on GitHub, linking the review thread in the issue or vice versa will create corresponding breadcrumb trails in the link target.)

Reviewer instructions & questions

@sandeep-ps & @zhangjy-ge, your review will be checklist based. Each of you will have a separate checklist that you should update when carrying out your review.
First of all you need to run this command in a separate comment to create the checklist:

@editorialbot generate my checklist

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @osorensen know.

Please start on your review when you are able, and be sure to complete your review in the next six weeks, at the very latest

Checklists

📝 Checklist for @sandeep-ps

📝 Checklist for @zhangjy-ge

@editorialbot editorialbot added C++ CMake review Shell Track: 5 (DSAIS) Data Science, Artificial Intelligence, and Machine Learning labels Dec 23, 2022
@editorialbot
Copy link
Collaborator Author

Hello humans, I'm @editorialbot, a robot that can help you with some common editorial tasks.

For a list of things I can do to help you, just type:

@editorialbot commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author
Software report:

github.com/AlDanial/cloc v 1.88  T=2.49 s (648.4 files/s, 148650.4 lines/s)
-------------------------------------------------------------------------------------
Language                           files          blank        comment           code
-------------------------------------------------------------------------------------
C/C++ Header                        1194          29525          70231         132436
C++                                  266          17996          24091          65742
Markdown                              48           3033              1          10745
CMake                                 60            734           1257           7159
Python                                 7            350            457           1459
Go                                     5            211            141           1114
YAML                                   8             82            103            531
Julia                                  1             88             55            335
Bourne Shell                           5             58             67            293
Cython                                 7             96            200            284
R                                      4             80             66            228
XML                                    3              0              0            211
TeX                                    1             23              0            189
CSS                                    1             19             11            121
JavaScript                             1              8             20             82
MSBuild script                         1              0              0             52
WiX source                             1              4              2             33
WiX string localization                1              1              0              6
-------------------------------------------------------------------------------------
SUM:                                1614          52308          96702         221020
-------------------------------------------------------------------------------------


gitinspector failed to run statistical information for the repository

@editorialbot
Copy link
Collaborator Author

Wordcount for paper.md is 1283

@editorialbot
Copy link
Collaborator Author

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@sandeep-ps
Copy link
sandeep-ps commented Dec 24, 2022

Review checklist for @sandeep-ps

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the https://github.com/mlpack/mlpack?
  • License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@rcurtin) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines
  • Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
  • Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
  • Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item.

Functionality

  • Installation: Does installation proceed as outlined in the documentation?
  • Functionality: Have the functional claims of the software been confirmed?
  • Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
  • Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
  • Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

  • Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • A statement of need: Does the paper have a section titled 'Statement of need' that clearly states what problems the software is designed to solve, who the target audience is, and its relation to other work?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

@zhangjy-ge
Copy link
zhangjy-ge commented Dec 24, 2022

Review checklist for @zhangjy-ge

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the https://github.com/mlpack/mlpack?
  • License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@rcurtin) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines
  • Data sharing: If the paper contains original data, data are accessible to the reviewers. If the paper contains no original data, please check this item.
  • Reproducibility: If the paper contains original results, results are entirely reproducible by reviewers. If the paper contains no original results, please check this item.
  • Human and animal research: If the paper contains original data research on humans subjects or animals, does it comply with JOSS's human participants research policy and/or animal research policy? If the paper contains no such data, please check this item.

Functionality

  • Installation: Does installation proceed as outlined in the documentation?
  • Functionality: Have the functional claims of the software been confirmed?
  • Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
  • Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
  • Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

  • Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • A statement of need: Does the paper have a section titled 'Statement of need' that clearly states what problems the software is designed to solve, who the target audience is, and its relation to other work?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

@zhangjy-ge
Copy link

I have finished my initial review. I think overall, mlpack 4 is a well written package that has indicated great potential in the machine learning field, considering its good documentation, user friendliness, and the algorithms it implemented, etc. Thus, I would recommend it for publication after minor revision:

  1. even though I understand that in mlpack's website, there are some comparisons between mlpack and other similar packages, it is not mentioned in the manuscript itself. I would suggest the authors to add such descriptions, based on the requirements of "State of the field" and "performance" in the checklist.

@sandeep-ps
Copy link

Hi, @osorensen,

Two authors listed in the paper (#5 and #9) are affiliated with the same institution I'm affiliated with. We are from different units and haven't collaborated in the past, and we do not know each other. I request that this conflict be waived. Please let me know if there is a different process for this. Thanks.

@osorensen
Copy link
Member

Hi, @osorensen,

Two authors listed in the paper (#5 and #9) are affiliated with the same institution I'm affiliated with. We are from different units and haven't collaborated in the past, and we do not know each other. I request that this conflict be waived. Please let me know if there is a different process for this. Thanks.

Thanks for letting me know @sandeep-ps. I think this should be waived, but I'll ping the editor-in-chief @openjournals/dsais-eics to hear what they think.

@gkthiruvathukal
Copy link

@sandeep-ps Thanks for letting us know. I'm a bit reticent about waiving the COI because there are implications of reviewing work by others at your institution if you are both still employed there. I'd prefer that we seek a different reviewer and hope we can assign you to another submission where we need reviewers. Ok? Thank you for understanding.

@osorensen Please assign to a different reviewer and keep @sandeep-ps in mind for other assignments!

@sandeep-ps
Copy link
sandeep-ps commented Dec 31, 2022

Okay. Sounds good. Thanks.

FYI, my request was based on the COI guidelines, specifically, this statement.

@danielskatz
Copy link

HI @sandeep-ps - thanks for bringing this up. You are correct in that it is a conflict, and that it could be waived if needed, but it's up the track editor to decide.

@gkthiruvathukal
Copy link

Ok, @sandeep-ps, since you can attest that you are in a large organization and unlikely to be in contact with the individual profesionally, I am willing to grant the waiver. Given that we also have some independent feedback from the other reviewer, I think this might be ok. Let's proceed with you as a reviewer!

@osorensen
Copy link
Member

Thanks @gkthiruvathukal. Then please continue with the review @sandeep-ps, and feel free to reach out to me if you have any questions about the review process.

@sandeep-ps
Copy link

Thanks, @gkthiruvathukal, @danielskatz, and @osorensen. I will continue with the review then.

@rcurtin
Copy link
rcurtin commented Jan 9, 2023

I am not sure of the exact process, but when should I start responding to the review comments? Should I wait for @sandeep-ps's review to be complete? It would be straightforward to add some comparisons with other machine learning libraries, so I'm happy to do that.

@osorensen
Copy link
Member

Thanks for asking @rcurtin. You're welcome and encouraged to start responding immediately.

@sandeep-ps
Copy link

@rcurtin, to give a progress update, since I had not used this library before, I was going through the installation process and checking out some of the functionality. I ran into some issues during that step last week, and I will be continuing my review this week.

@rcurtin
Copy link
rcurtin commented Jan 13, 2023

I have finished my initial review. I think overall, mlpack 4 is a well written package that has indicated great potential in the machine learning field, considering its good documentation, user friendliness, and the algorithms it implemented, etc. Thus, I would recommend it for publication after minor revision:

1. even though I understand that in mlpack's website, there are some comparisons between mlpack and other similar packages, it is not mentioned in the manuscript itself. I would suggest the authors to add such descriptions, based on the requirements of "State of the field" and "performance" in the checklist.

@zhangjy-ge We do have some benchmarks on the homepage of the website. We can reference them more prominently in the paper---or do you mean to include some benchmarks specifically in the paper itself? (Personally I think it might be too long with a benchmarking table and sufficient description.)

@rcurtin, to give a progress update, since I had not used this library before, I was going through the installation process and checking out some of the functionality. I ran into some issues during that step last week, and I will be continuing my review this week.

@sandeep-ps happy to help out, just send a ping if you are having any issues. (You could even open an issue on mlpack's Github if you wanted, but whatever way is fine.) Often it can be easier to install mlpack via the system package manager, but our recent refactorings to make mlpack header-only have made the process much easier than it used to be.

@zhangjy-ge
Copy link

@rcurtin After double check, it seems a performance comparison is optional but we should still explicitly state the difference between mlpack and other packages (from Do the authors describe how this software compares to other commonly-used packages?) So maybe a short description of mlpack's differences comparing to other packages will be helpful.

@osorensen
Copy link
Member

@editorialbot set 4.0.1 as release

@editorialbot
Copy link
Collaborator Author

I'm sorry human, I don't understand that. You can see what commands I support by typing:

@editorialbot commands

@osorensen
Copy link
Member

@editorialbot set 4.0.1 as version

@editorialbot
Copy link
Collaborator Author

Done! version is now 4.0.1

@osorensen
Copy link
Member

@editorialbot recommend-accept

@editorialbot
Copy link
Collaborator Author
Attempting dry run of processing paper acceptance...

@editorialbot
Copy link
Collaborator Author

👋 @openjournals/dsais-eics, this paper is ready to be accepted and published.

Check final proof 👉📄 Download article

If the paper PDF and the deposit XML files look good in openjournals/joss-papers#3923, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

@editorialbot editorialbot added the recommend-accept Papers recommended for acceptance in JOSS. label Jan 31, 2023
@editorialbot
Copy link
Collaborator Author
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- None

MISSING DOIs

- 10.21105/joss.00726 may be a valid DOI for title: mlpack 3: a fast, flexible machine learning library
- 10.1126/science.aaa8415 may be a valid DOI for title: Machine learning: Trends, perspectives, and prospects
- 10.1145/3219819.3220124 may be a valid DOI for title: Training big random forests with little resources
- 10.1145/3533378 may be a valid DOI for title: Challenges in deploying machine learning: a survey of case studies
- 10.21203/rs.3.rs-133138/v1 may be a valid DOI for title: Technology readiness levels for machine learning systems
- 10.3390/make3010004 may be a valid DOI for title: AI System Engineering—Key Challenges and Lessons Learned
- 10.1007/978-3-319-46759-7_17 may be a valid DOI for title: Fast approximate furthest neighbors with data-dependent candidate selection
- 10.1002/sam.11218 may be a valid DOI for title: Dual-tree fast exact max-kernel search
- 10.21105/joss.00026 may be a valid DOI for title: Armadillo: a template-based C++ library for linear algebra
- 10.1137/141000671 may be a valid DOI for title: Julia: A fresh approach to numerical computing
- 10.1109/tbdata.2019.2921572 may be a valid DOI for title: Billion-scale similarity search with GPUs
- 10.5220/0001787803310340 may be a valid DOI for title: Fast approximate nearest neighbors with automatic algorithm configuration

INVALID DOIs

- None

@osorensen
Copy link
Member

Sorry @rcurtin, I forgot to check the references. Could you please add the suggested DOIs above to your .bib file?

@rcurtin
Copy link
rcurtin commented Jan 31, 2023

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@rcurtin
Copy link
rcurtin commented Jan 31, 2023

@editorialbot check references

@editorialbot
Copy link
Collaborator Author
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.21105/joss.00726 is OK
- 10.1126/science.aaa8415 is OK
- 10.1103/RevModPhys.91.045002 is OK
- 10.1145/3219819.3220124 is OK
- 10.1145/3533378 is OK
- 10.21203/rs.3.rs-133138/v1 is OK
- 10.3390/make3010004 is OK
- 10.1007/978-3-319-46759-7_17 is OK
- 10.1137/1.9781611974973.34 is OK
- 10.1002/sam.11218 is OK
- 10.21105/joss.00026 is OK
- 10.3233/978-1-61499-649-1-87 is OK
- 10.1137/141000671 is OK
- 10.1109/tbdata.2019.2921572 is OK
- 10.5220/0001787803310340 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@rcurtin
Copy link
rcurtin commented Jan 31, 2023

Ok @osorensen, I think I've got everything worked out. Let me know if there's anything else to do. Thanks! 👍

@osorensen
Copy link
Member

@editorialbot recommend-accept

@editorialbot
Copy link
Collaborator Author
Attempting dry run of processing paper acceptance...

@editorialbot
Copy link
Collaborator Author

👋 @openjournals/dsais-eics, this paper is ready to be accepted and published.

Check final proof 👉📄 Download article

If the paper PDF and the deposit XML files look good in openjournals/joss-papers#3929, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

@editorialbot
Copy link
Collaborator Author
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.21105/joss.00726 is OK
- 10.1126/science.aaa8415 is OK
- 10.1103/RevModPhys.91.045002 is OK
- 10.1145/3219819.3220124 is OK
- 10.1145/3533378 is OK
- 10.21203/rs.3.rs-133138/v1 is OK
- 10.3390/make3010004 is OK
- 10.1007/978-3-319-46759-7_17 is OK
- 10.1137/1.9781611974973.34 is OK
- 10.1002/sam.11218 is OK
- 10.21105/joss.00026 is OK
- 10.3233/978-1-61499-649-1-87 is OK
- 10.1137/141000671 is OK
- 10.1109/tbdata.2019.2921572 is OK
- 10.5220/0001787803310340 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@arfon
Copy link
Member
arfon commented Feb 1, 2023

@editorialbot accept

@editorialbot
Copy link
Collaborator Author
Doing it live! Attempting automated processing of paper acceptance...

@editorialbot
Copy link
Collaborator Author

🐦🐦🐦 👉 Tweet for this paper 👈 🐦🐦🐦

@editorialbot
Copy link
Collaborator Author

🐘🐘🐘 👉 Toot for this paper 👈 🐘🐘🐘

@editorialbot
Copy link
Collaborator Author

🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨

Here's what you must now do:

  1. Check final PDF and Crossref metadata that was deposited 👉 Creating pull request for 10.21105.joss.05026 joss-papers#3931
  2. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.05026
  3. If everything looks good, then close this review issue.
  4. Party like you just published a paper! 🎉🌈🦄💃👻🤘

Any issues? Notify your editorial technical team...

@editorialbot editorialbot added accepted published Papers published in JOSS labels Feb 1, 2023
@arfon
Copy link
Member
arfon commented Feb 1, 2023

@sandeep-ps, @zhangjy-ge – many thanks for your reviews here and to @osorensen for editing this submission! JOSS relies upon the volunteer effort of people like you and we simply wouldn't be able to do this without you ✨

@rcurtin – your paper is now accepted and published in JOSS ⚡🚀💥

@arfon arfon closed this as completed Feb 1, 2023
@editorialbot
Copy link
Collaborator Author

🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉

If you would like to include a link to your paper from your README use the following code snippets:

Markdown:
[![DOI](https://joss.theoj.org/papers/10.21105/joss.05026/status.svg)](https://doi.org/10.21105/joss.05026)

HTML:
<a style="border-width:0" href="https://doi.org/10.21105/joss.05026">
  <img src="https://joss.theoj.org/papers/10.21105/joss.05026/status.svg" alt="DOI badge" >
</a>

reStructuredText:
.. image:: https://joss.theoj.org/papers/10.21105/joss.05026/status.svg
   :target: https://doi.org/10.21105/joss.05026

This is how it will look in your documentation:

DOI

We need your help!

The Journal of Open Source Software is a community-run journal and relies upon volunteer effort. If you'd like to support us please consider doing either one (or both) of the the following:

@rcurtin
Copy link
rcurtin commented Feb 1, 2023

Thanks everyone!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted C++ CMake published Papers published in JOSS recommend-accept Papers recommended for acceptance in JOSS. review Shell Track: 5 (DSAIS) Data Science, Artificial Intelligence, and Machine Learning
Projects
None yet
Development

No branches or pull requests

8 participants