-
-
Notifications
You must be signed in to change notification settings - Fork 39
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]: sbi reloaded: a toolkit for simulation-based inference workflows #7754
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:
|
Software report:
Commit count by author:
|
Paper file info: 🚨 Wordcount for ✅ The paper includes a |
License info: ✅ License found: |
|
Review checklist for @arnauqbConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Review checklist for @francois-rozetConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
@boisgera I have read the paper and filled the checklist. The improvements are significant and welcome. I only have two concerns:
In addition, I would suggest not to provide the source code directly in the documentation, but to link to the code repository instead. This is possible with Sphinx, I don't know if it is with mkdocs. |
I'm happy with how the repo is structured and I think all the tests and documentation are of very high standard. I only have a few suggestions:
|
Thanks a lot for these reviews, many great points there! As @arnauqb mentions, several DOIs are missing from the bibliography. The bibliography should be updated to include DOIs whenever they exist (this is will be checked in post-review by myself and the editor in chief in any case). Let's allow @janfb to consider this feedback and get back to us. |
Thanks a lot @francois-rozet and @arnauqb for your timely and constructive reviews! Thanks @boisgera for the update. We will work on the mentioned points and get back to you as as soon as possible. |
@francois-rozet thanks again for your review!
Good catch! We update the documentation accordingly, see here: sbi-dev/sbi#1387
Good point, thanks. We updated the paper and references accordingly.
Thanks for your feedback! Just to clarify—are you referring to the tutorial notebooks on the website? We use MkDocs and nbconvert to display the latest version of the notebooks for each release (as selected on the site). Plus, each notebook includes links to the corresponding file in the GitHub repository. Does that address your concern about the source code in the documentation? |
@arnauqb thanks again for your review!
Very good point! We added a paragraph at the beginning of the related software section: "Simulation-based inference methods implemented in the
It makes sense to add this paper as well, thanks! We added it to the new paragraph (see above).
Another good point, thanks! We are currently discussion how to make the tests faster, e.g., by improving the test suite itself, and by reducing the set of core tests used during CI, (see sbi-dev/sbi#1378). Does this address all the comments and concerns you had? |
@boisgera I pushed the edits in the main text and the references (fixed DOIs) to the submission branch (https://github.com/sbi-dev/sbi/tree/joss-submission-2024). We have question regarding the formatting of the author list: We have several groups of authors who contributed equally at different levels. E.g., Michael Deistler and me are both maintainers and equally contributing first authors. The following four authors on the list are "core contributors" and the next five are "major contributors", setting them apart from regular "contributors". Is there a way to format the groups with superscripts in the JOSS markdown template (similar to how we did it on arvix, https://arxiv.org/pdf/2411.17337)? Thanks! |
Thank you for addressing my comments. Everything seems good to me. Great work!
I am referring to the source code present in the API section of the website. These code blocks are not very legible without code highlighting, and the code lines are not aligned with the line numbers on the left. Another issue with these source code blocks is that they don't allow to search the code base (where is this function defined, what does it do, what are the arguments, ...). Linking to the source code in the repo is much more valuable. For example, in the Zuko library, the code I don't know if this is possible in mkdocs, but if it is, you should consider it. The tutorials are very good. |
Thanks for clarifying @francois-rozet! Agreed. I created an issue and we will work on this during the upcoming hackathon where a major re-work of the documentation is planned. |
Thank you for addressing my comments @janfb . Good to go from my part! |
Great, thank you!
Ah, that's a good question. I have never edited a paper with this need before, let me ask my fellow co-editors and get back to you! |
@janfb Wrt to the superscript for authors issue: I have not received any answers (yet) from my co-editors. Therefore I suspect that it's not something that's been asked before. Let me have a look at the document processor (https://github.com/openjournals/inara) and I'll get back to you. |
To: @janfb AFAICT there is a bug in inara when you try to add a custom footnote for a corresponding author; see openjournals/inara#105. I advise you to follow this issue. If no solution in a reasonable time frame, then we'll reconsider your options. Is that a plan that works for you? |
Hi @boisgera thanks a lot for looking into this. Yes, I will have a look at the issue for editing the author list and let you know. Thanks! |
Submitting author: @janfb (Jan Boelts)
Repository: https://github.com/sbi-dev/sbi
Branch with paper.md (empty if default branch): joss-submission-2024
Version: v0.23.2
Editor: @boisgera
Reviewers: @arnauqb, @francois-rozet
Archive: Pending
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
@arnauqb & @francois-rozet, 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 @boisgera 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 @arnauqb
📝 Checklist for @francois-rozet
The text was updated successfully, but these errors were encountered: