Closed editorialbot closed 11 months ago
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
Software report:
github.com/AlDanial/cloc v 1.88 T=0.06 s (1018.1 files/s, 120804.0 lines/s)
-------------------------------------------------------------------------------
Language files blank comment code
-------------------------------------------------------------------------------
Python 36 417 508 1986
SVG 2 0 0 996
Jupyter Notebook 7 0 2309 447
Markdown 12 81 0 278
YAML 4 22 9 185
TeX 1 17 0 160
CSS 1 39 20 104
JavaScript 1 1 0 15
-------------------------------------------------------------------------------
SUM: 64 577 2846 4171
-------------------------------------------------------------------------------
gitinspector failed to run statistical information for the repository
Wordcount for paper.md
is 1229
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):
OK DOIs
- 10.5281/zenodo.4296287 is OK
- 10.21105/joss.05361 is OK
- 10.21105/joss.02505 is OK
- 10.21105/joss.04622 is OK
- 10.21105/joss.05428 is OK
- 10.18637/jss.v100.i07 is OK
- 10.21105/joss.04304 is OK
MISSING DOIs
- 10.1016/j.jempfin.2009.06.006 may be a valid DOI for title: Applying the method of simulated moments to estimate a small agent-based asset pricing model
- 10.2307/3318418 may be a valid DOI for title: Exponential convergence of Langevin distributions and their discrete approximations
- 10.1111/rssb.12158 may be a valid DOI for title: A general framework for updating belief distributions
INVALID DOIs
- None
(note to self not to pester @marvinschmitt about review progress before early September π)
:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:
Hi @rajeshrinet and @marvinschmitt, just checking in on review progress here! As you proceed, feel free to open issues/PR's in the project repo; if you do so, link back to this review issue for easy tracking.
Aaaand I blatantly disregarded my note to self above, apologies Marvin, feel free to disregard for a few days
A few comments on the paper itself:
[...] simulation models (see e.g. Bayedin et al. (2020))
and should be [...] simulation models (see e.g., Bayedin et al., 2020)
.e.g.
should be followed by a comma. Just mentioning it because it occurred in the citation example from above.{B}ayesian
in the .bib
file for proper capitalization.BayesFlow
package for amortized Bayesian workflows (focus on simulation-based inference) to the list of related software. I'm one of the authors of that package, so this is just a suggestion and strictly optional.@misc{radev2023bayesflow,
title = {BayesFlow: Amortized Bayesian Workflows With Neural Networks},
author = {Stefan T Radev and Marvin Schmitt and Lukas Schumacher and Lasse Elsem\"{u}ller and Valentin Pratz and Yannik Sch\"{a}lte and Ullrich K\"{o}the and Paul-Christian B\"{u}rkner},
year = {2023},
publisher= {arXiv},
url={https://arxiv.org/abs/2306.16015}
}
Thank you for the reviewers @marvinschmitt @rajeshrinet for agreeing to review blackbirds. I just came back from annual leave and will go through the comments over the next day(s).
A few comments on the paper itself:
- The in-text citations within parentheses are incorrectly formatted. It's currently
[...] simulation models (see e.g. Bayedin et al. (2020))
and should be[...] simulation models (see e.g., Bayedin et al., 2020)
.- A tiny pet peeve of mine:
e.g.
should be followed by a comma. Just mentioning it because it occurred in the citation example from above.- Please add curly braces around
{B}ayesian
in the.bib
file for proper capitalization.- The sentence [Our package is used] in forthcoming publications yet to be announced publicly doesn't age well. I would suggest removing it altogether.
- You could consider adding the
BayesFlow
package for amortized Bayesian workflows (focus on simulation-based inference) to the list of related software. I'm one of the authors of that package, so this is just a suggestion and strictly optional.@misc{radev2023bayesflow, title = {BayesFlow: Amortized Bayesian Workflows With Neural Networks}, author = {Stefan T Radev and Marvin Schmitt and Lukas Schumacher and Lasse Elsem\"{u}ller and Valentin Pratz and Yannik Sch\"{a}lte and Ullrich K\"{o}the and Paul-Christian B\"{u}rkner}, year = {2023}, publisher= {arXiv}, url={https://arxiv.org/abs/2306.16015} }
Thank you for the comments / suggestions, I have now incorporated them into the paper. Latest version: https://github.com/arnauqb/blackbirds/suites/16358519183/artifacts/934384480
@rkurchin I have completed my first review of the code and the paper. The software looks very good. The paper is well written with a clear statement of need and state of the field.
I found a few problems with installation, but @arnauqb addressed those.
I have made a few suggestions via issues on the code repository, which the authors have handled.
Some comments (optional) for the authors to consider:
High-level summary in the paper: the current summary of the paper is clear enough for potential software users but not for a diverse, non-specialist audience. Similarly, there needs to be more description (in the form of comments) in the example files on GitHub. I suggest adding a README in the examples
folder and some more comments in the representative examples.
State of the field: the paper compares with other commonly used packages. In addition, I want to bring to the attention, the PyRoss library: https://github.com/rajeshrinet/pyross. I am one of the team members who developed PyRoss. PyRoss allows full Bayesian inference on any user-defined compartment epidemiological models through Python dictionaries. The inherent method - derived from functional limit theorems for Markov population process - is not limited to compartment epidemiological models.
Thank you for addressing my comments @arnauqb. Based on the edits, I have updated my review checklist.
BTW: The BayesFlow paper has just been published in JOSS last week, so you could directly update the reference.
@article{Radev_BayesFlow_Amortized_Bayesian_2023,
author = {Radev, Stefan T. and Schmitt, Marvin and Schumacher, Lukas and ElsemΓΌller, Lasse and Pratz, Valentin and SchΓ€lte, Yannik and KΓΆthe, Ullrich and BΓΌrkner, Paul-Christian},
doi = {10.21105/joss.05702},
journal = {Journal of Open Source Software},
month = sep,
number = {89},
pages = {5702},
title = {{BayesFlow: Amortized Bayesian Workflows With Neural Networks}},
url = {https://joss.theoj.org/papers/10.21105/joss.05702},
volume = {8},
year = {2023}
}
I've updated the BayesFlow reference and added an additional README to the examples folder. Thank you very much for your helpful comments and additions.
I believe this concludes the review @rkurchin ?
@editorialbot generate post-review checklist
I'm sorry human, I don't understand that. You can see what commands I support by typing:
@editorialbot commands
@editorialbot set <DOI here> as archive
@editorialbot set <version here> as version
@editorialbot generate pdf
@editorialbot check references
and ask author(s) to update as needed@editorialbot recommend-accept
@editorialbot check references
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):
OK DOIs
- 10.5281/zenodo.4296287 is OK
- 10.21105/joss.05361 is OK
- 10.1016/j.jempfin.2009.06.006 is OK
- 10.2307/3318418 is OK
- 10.1111/rssb.12158 is OK
- 10.21105/joss.02505 is OK
- 10.21105/joss.04622 is OK
- 10.21105/joss.05428 is OK
- 10.18637/jss.v100.i07 is OK
- 10.21105/joss.04304 is OK
- 10.21105/joss.05702 is OK
MISSING DOIs
- None
INVALID DOIs
- None
Thanks everyone! Authors, I'll do an editorial pass over the manuscript and send any comments shortly. In the meantime, the immediate next steps for you are (take a look at the checklist above, too):
@editorialbot generate pdf
:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:
Editorial comments:
I'm pretty sure this is the fewest editorial comments I've ever given! π
Conceptual question: Is it currently the case that everything needs to be in PyTorch? For example, could a model be in JAX, or even in some other AD-able language like Julia? It would be helpful to clarify this, and if it's not currently possible, it's obviously beyond the scope of this review but I would selfishly be thrilled if this could be possible π
@editorialbot set 1.2 as version
Done! version is now 1.2
@editorialbot set 10.5281/zenodo.8377044 as archive
Done! archive is now 10.5281/zenodo.8377044
Editorial comments:
- line 19: "means to" somehow sounds weird to me and it feels like it should be "means of" although I can't explain why (this should be considered an optional change)
- second page: be consistent about whether equations in the middle of a sentence have commas after them (I lean towards including them, i.e. adding them in equations (2) and (3) to be consistent with (1))
I'm pretty sure this is the fewest editorial comments I've ever given! π
Conceptual question: Is it currently the case that everything needs to be in PyTorch? For example, could a model be in JAX, or even in some other AD-able language like Julia? It would be helpful to clarify this, and if it's not currently possible, it's obviously beyond the scope of this review but I would selfishly be thrilled if this could be possible π
Thanks for the comments! Just corrected the small typos and pushed the later paper version to the main branch.
For now, the package only supports PyTorch, so all models need to be in Torch. This is because we require the whole pipeline to use torch.autograd. It would certainly be cool if we could support other frameworks / languages, maybe in the future!
@editorialbot recommend-accept
Attempting dry run of processing paper acceptance...
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):
OK DOIs
- 10.5281/zenodo.4296287 is OK
- 10.21105/joss.05361 is OK
- 10.1016/j.jempfin.2009.06.006 is OK
- 10.2307/3318418 is OK
- 10.1111/rssb.12158 is OK
- 10.21105/joss.02505 is OK
- 10.21105/joss.04622 is OK
- 10.21105/joss.05428 is OK
- 10.18637/jss.v100.i07 is OK
- 10.21105/joss.04304 is OK
- 10.21105/joss.05702 is OK
MISSING DOIs
- None
INVALID DOIs
- None
:wave: @openjournals/dsais-eics, this paper is ready to be accepted and published.
Check final proof :point_right::page_facing_up: Download article
If the paper PDF and the deposit XML files look good in https://github.com/openjournals/joss-papers/pull/4607, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept
@editorialbot accept
Doing it live! Attempting automated processing of paper acceptance...
Ensure proper citation by uploading a plain text CITATION.cff file to the default branch of your repository.
If using GitHub, a Cite this repository menu will appear in the About section, containing both APA and BibTeX formats. When exported to Zotero using a browser plugin, Zotero will automatically create an entry using the information contained in the .cff file.
You can copy the contents for your CITATION.cff file here:
``` cff-version: "1.2.0" authors: - family-names: Quera-Bofarull given-names: Arnau orcid: "https://orcid.org/0000-0001-5055-9863" - family-names: Dyer given-names: Joel orcid: "https://orcid.org/0000-0002-8304-8450" - family-names: Calinescu given-names: Anisoara orcid: "https://orcid.org/0000-0003-2082-734X" - family-names: Farmer given-names: J. Doyne orcid: "https://orcid.org/0000-0001-7871-073X" - family-names: Wooldridge given-names: Michael orcid: "https://orcid.org/0000-0002-9329-8410" contact: - family-names: Quera-Bofarull given-names: Arnau orcid: "https://orcid.org/0000-0001-5055-9863" - family-names: Dyer given-names: Joel orcid: "https://orcid.org/0000-0002-8304-8450" doi: 10.5281/zenodo.8377044 message: If you use this software, please cite our article in the Journal of Open Source Software. preferred-citation: authors: - family-names: Quera-Bofarull given-names: Arnau orcid: "https://orcid.org/0000-0001-5055-9863" - family-names: Dyer given-names: Joel orcid: "https://orcid.org/0000-0002-8304-8450" - family-names: Calinescu given-names: Anisoara orcid: "https://orcid.org/0000-0003-2082-734X" - family-names: Farmer given-names: J. Doyne orcid: "https://orcid.org/0000-0001-7871-073X" - family-names: Wooldridge given-names: Michael orcid: "https://orcid.org/0000-0002-9329-8410" date-published: 2023-09-28 doi: 10.21105/joss.05776 issn: 2475-9066 issue: 89 journal: Journal of Open Source Software publisher: name: Open Journals start: 5776 title: "BlackBIRDS: Black-Box Inference foR Differentiable Simulators" type: article url: "https://joss.theoj.org/papers/10.21105/joss.05776" volume: 8 title: "BlackBIRDS: Black-Box Inference foR Differentiable Simulators" ```
If the repository is not hosted on GitHub, a .cff file can still be uploaded to set your preferred citation. Users will be able to manually copy and paste the citation.
πππ π Toot 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...
@rajeshrinet, @marvinschmitt β many thanks for your reviews here and to @rkurchin 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 β¨
@arnauqb β your paper is now accepted and published in JOSS :zap::rocket::boom:
:tada::tada::tada: Congratulations on your paper acceptance! :tada::tada::tada:
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.05776/status.svg)](https://doi.org/10.21105/joss.05776)
HTML:
<a style="border-width:0" href="https://doi.org/10.21105/joss.05776">
<img src="https://joss.theoj.org/papers/10.21105/joss.05776/status.svg" alt="DOI badge" >
</a>
reStructuredText:
.. image:: https://joss.theoj.org/papers/10.21105/joss.05776/status.svg
:target: https://doi.org/10.21105/joss.05776
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: !--author-handle-->@arnauqb<!--end-author-handle-- (Arnau Quera-Bofarull) Repository: https://github.com/arnauqb/blackbirds Branch with paper.md (empty if default branch): Version: 1.2 Editor: !--editor-->@rkurchin<!--end-editor-- Reviewers: @rajeshrinet, @marvinschmitt Archive: 10.5281/zenodo.8377044
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
@rajeshrinet & @marvinschmitt, 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 @rkurchin 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 @rajeshrinet
π Checklist for @marvinschmitt