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]: graphenv: a Python library for reinforcement learning on graph search spaces #4621
Comments
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:
For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:
|
|
Wordcount for |
|
Review checklist for @idobyConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Review checklist for @iammixConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
This seems like a very interesting package! I will have the time to dive in more in-depth soon, but in the meanwhile, can the authors fix the citation on line 17 of the paper to be consistent with the other citations, and resolve the invalid citation issue? Also, please clarify the contributions of the two extra authors who are not listed as collaborators on the GitHub repo. Thanks! |
@editorialbot generate pdf |
Hello @idoby, here are the things you can ask me to do:
|
|
Apologies if these contribution edits should have been made in the manuscript?
That invalid DOI, 10.1038/s42256-022-00506-3, should be live starting 04 August 2022 at 11:00 (US Eastern Time) |
I'm pretty new at reviewing for JOSS, but the documentation does not state this information has to be specified in the manuscript. So I think just your comment should be fine.
OK, LGTM then. Appreciate your work on the library and thank you for contributing it. :) |
@pstjohn Looking at it now, it seems like the merge commit for Dmitry's PR prevented him being listed as a contributor by GitHub. I'm not sure why, since it usually works fine. |
Wanted to chime in as editor that I agree with you. Comments in this thread are sufficient. |
Review checklist for @vwxyzjnConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
@editorialbot check references |
|
The Paper and repo look good! Opened a couple of issues: NREL/graph-env#33 Also, please consider filling out the github repo's description and keywords. See the screenshot below as an example. |
Review checklist for @ViechConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
I have completed my review with some remarks below and will tick my remaining boxes when these points were addressed or discussed. Overall, I find that this is a small but nicely maintained and documented package whose scope could be described a bit better to a non-specialist audience. General checksSubstantial scholarly effortFunctionally this is a very small library: Excluding the FunctionalityInstallation
DocumentationA statement of need
Installation instructions
ManuscriptI find that the manuscript is well-written and concise but the distinction between graph search problems and other problem representations could be made more clear as this seems to be the selling point for the software. Author list
Summary
Statement of need
|
Thanks for your review @Viech! Regarding scholarly scope, the guidelines state as some factors to consider, which I will consider point-by-point below, while trying to "think out loud".
Looking at the repository, I find that the software seems rather young, with the first commit made on February 11 2022.
This is rather large, 241 in total.
There have been four contributors, which suggests that this is a joint effort.
This one has already been commented on in @Viech's review.
Could you please comment on this @pstjohn? Is the software used in academic paper, or are you aware of papers in preparation which will use the package.
This is an important point. Making a joint wrapper around two existing libraries can in itself be very useful for users not familiar with those libraries. In sum, I understand your concern about scholarly scope @Viech, and see that this is a difficult case. I would also be interested to hear what @iammix thinks of this, as the "Substantial scholarly effort" button has not been ticked off in your review checklist. Also @Viech, could you think of any suggested extensions of the package that would make it more clearly within scope for JOSS? You're of course also welcome to comment on this @pstjohn. |
@osorensen Just adding a comment here since I did check the respective checkbox. Following the discussion here I went back and checked the commit history in greater depth and found that a large number of commits are just one-liners or seem to be purely about cosmetics/experimenting with settings. So I would suggest the authors
Personally, I believe git history to be more than just a storage space for old versions of the code, it also serves to document the design and development process for a project, document decisions made, etc. (also, apologies, this is my first review and I didn't realize reviews could extend beyond the checklist) |
|
@pstjohn, as you see I've open three small issues in the source repository. When you have addressed these, and the four points points about release and archiving mentioned in my comment yesterday, I'm ready to go forward with acceptance. |
Took a couple tries to get the .zenodo.json metadata in the right format, but I think I've made the requested paper edits and these associated tags:
|
@editorialbot check references |
|
@editorialbot generate pdf |
@editorialbot set 10.5281/zenodo.7030161 as archive |
Done! Archive is now 10.5281/zenodo.7030161 |
@editorialbot set v0.1.3 as version |
Done! version is now v0.1.3 |
@editorialbot recommend-accept |
|
|
👋 @openjournals/joss-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#3486, then you can now move forward with accepting the submission by compiling again with the command |
@editorialbot accept |
|
🐦🐦🐦 👉 Tweet for this paper 👈 🐦🐦🐦 |
🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨 Here's what you must now do:
Any issues? Notify your editorial technical team... |
🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉 If you would like to include a link to your paper from your README use the following code snippets:
This is how it will look in your documentation: 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:
|
Submitting author: @pstjohn (Peter C. St. John)
Repository: https://github.com/NREL/graph-env/
Branch with paper.md (empty if default branch):
Version: v0.1.3
Editor: @osorensen
Reviewers: @iammix, @vwxyzjn, @Viech, @idoby
Archive: 10.5281/zenodo.7030161
Status
Status badge code:
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
@iammix & @vwxyzjn & @Viech & @idoby, 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:
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 @iammix
📝 Checklist for @vwxyzjn
📝 Checklist for @idoby
📝 Checklist for @Viech
The text was updated successfully, but these errors were encountered: