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]: TorchMetrics - Measuring Reproducibility in PyTorch #4101

Closed
60 tasks done
whedon opened this issue Jan 27, 2022 · 66 comments
Closed
60 tasks done

[REVIEW]: TorchMetrics - Measuring Reproducibility in PyTorch #4101

whedon opened this issue Jan 27, 2022 · 66 comments
Assignees
Labels
accepted Makefile published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review

Comments

@whedon
Copy link

whedon commented Jan 27, 2022

Submitting author: @justusschock (Justus Schock)
Repository: https://github.com/PyTorchLightning/metrics
Version: v0.7.2
Editor: @taless474
Reviewer: @inpefess, @richrobe, @reneraab
Archive: 10.5281/zenodo.6037875

⚠️ JOSS reduced service mode ⚠️

Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post.

Status

status

Status badge code:

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

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

@inpefess & @richrobe & @reneraab, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:

  1. Make sure you're logged in to your GitHub account
  2. Be sure to accept the invite at this URL: https://github.com/openjournals/joss-reviews/invitations

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @taless474 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

Review checklist for @inpefess

✨ Important: Please do not use the Convert to issue functionality when working through this checklist, instead, please open any new issues associated with your review in the software repository associated with the submission. ✨

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 repository url?
  • 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 (@justusschock) 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

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 and who the target audience is?
  • 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?

Review checklist for @richrobe

✨ Important: Please do not use the Convert to issue functionality when working through this checklist, instead, please open any new issues associated with your review in the software repository associated with the submission. ✨

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 repository url?
  • 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 (@justusschock) 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

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 and who the target audience is?
  • 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?

Review checklist for @reneraab

✨ Important: Please do not use the Convert to issue functionality when working through this checklist, instead, please open any new issues associated with your review in the software repository associated with the submission. ✨

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 repository url?
  • 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 (@justusschock) 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

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 and who the target audience is?
  • 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?
@whedon
Copy link
Author

whedon commented Jan 27, 2022

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @inpefess, @richrobe, @reneraab it looks like you're currently assigned to review this paper 🎉.

⚠️ JOSS reduced service mode ⚠️

Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post.

⭐ Important ⭐

If you haven't already, you should seriously consider unsubscribing from GitHub notifications for this (https://github.com/openjournals/joss-reviews) repository. As a reviewer, you're probably currently watching this repository which means for GitHub's default behaviour you will receive notifications (emails) for all reviews 😿

To fix this do the following two things:

  1. Set yourself as 'Not watching' https://github.com/openjournals/joss-reviews:

watching

  1. You may also like to change your default settings for this watching repositories in your GitHub profile here: https://github.com/settings/notifications

notifications

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

@whedon commands

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

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Jan 27, 2022

Wordcount for paper.md is 1168

@whedon
Copy link
Author

whedon commented Jan 27, 2022

PDF failed to compile for issue #4101 with the following error:

 /app/vendor/bundle/ruby/2.6.0/bundler/gems/whedon-c5c16aedb3d6/lib/whedon.rb:204:in `block in parse_authors': Author (Maxim Grechkin) is missing affiliation (RuntimeError)
	from /app/vendor/bundle/ruby/2.6.0/bundler/gems/whedon-c5c16aedb3d6/lib/whedon.rb:202:in `each'
	from /app/vendor/bundle/ruby/2.6.0/bundler/gems/whedon-c5c16aedb3d6/lib/whedon.rb:202:in `parse_authors'
	from /app/vendor/bundle/ruby/2.6.0/bundler/gems/whedon-c5c16aedb3d6/lib/whedon.rb:93:in `initialize'
	from /app/vendor/bundle/ruby/2.6.0/bundler/gems/whedon-c5c16aedb3d6/lib/whedon/processor.rb:38:in `new'
	from /app/vendor/bundle/ruby/2.6.0/bundler/gems/whedon-c5c16aedb3d6/lib/whedon/processor.rb:38:in `set_paper'
	from /app/vendor/bundle/ruby/2.6.0/bundler/gems/whedon-c5c16aedb3d6/bin/whedon:58:in `prepare'
	from /app/vendor/bundle/ruby/2.6.0/gems/thor-0.20.3/lib/thor/command.rb:27:in `run'
	from /app/vendor/bundle/ruby/2.6.0/gems/thor-0.20.3/lib/thor/invocation.rb:126:in `invoke_command'
	from /app/vendor/bundle/ruby/2.6.0/gems/thor-0.20.3/lib/thor.rb:387:in `dispatch'
	from /app/vendor/bundle/ruby/2.6.0/gems/thor-0.20.3/lib/thor/base.rb:466:in `start'
	from /app/vendor/bundle/ruby/2.6.0/bundler/gems/whedon-c5c16aedb3d6/bin/whedon:131:in `<top (required)>'
	from /app/vendor/bundle/ruby/2.6.0/bin/whedon:23:in `load'
	from /app/vendor/bundle/ruby/2.6.0/bin/whedon:23:in `<main>'

@whedon
Copy link
Author

whedon commented Jan 27, 2022

Software report (experimental):

github.com/AlDanial/cloc v 1.88  T=0.42 s (767.8 files/s, 118790.1 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                         267           7280          14825          22663
YAML                            21            165            135           1017
Markdown                         9            341              0            925
reStructuredText                12            725            830            781
JSON                             1              0              0             95
TeX                              1              5              0             80
JavaScript                       1              3             11             50
TOML                             2              9              1             37
make                             2             10              9             31
DOS Batch                        1              8              1             26
Jinja Template                   1              0              0             16
SVG                              3              0              0             11
Dockerfile                       1              6             12              8
HTML                             1              2              0              8
Bourne Shell                     1              0              0              2
-------------------------------------------------------------------------------
SUM:                           324           8554          15824          25750
-------------------------------------------------------------------------------


Statistical information for the repository '618798d2276e58950143fe2d' was
gathered on 2022/01/27.
The following historical commit information, by author, was found:

Author                     Commits    Insertions      Deletions    % of changes
Abe Botros                       1           179             55            0.22
Abhik Banerjee                   1             1              1            0.00
Abhinav Gupta                    1            19              7            0.02
Adrian Wälchli                   3             9             15            0.02
Aki Nitta                        2           175             61            0.22
Akihiro Nitta                    3            64             92            0.14
Alan Du                          1           199              0            0.18
Alexander Senov                  1            51             44            0.09
Ananya Harsh Jha                 4          1803           7573            8.66
Anselm Coogan                    1           210             50            0.24
Arnaud Gelas                     2           157            183            0.31
Artur Jaroszewicz                1            46              2            0.04
Arvind Muralie                   1           760              0            0.70
Ashutosh Kumar                   4           761            769            1.41
Bernardo Lourenço                1             2              2            0.00
Bhadresh Savani                  3           433             29            0.43
Björn Barz                       1            57              6            0.06
CSautier                         1             8              3            0.01
Celyn Walters                    1            95             42            0.13
Cookie_thief                     2            51              6            0.05
Daniel Stancl                   13          5804           1094            6.37
Davide Fiocco                    1            27             27            0.05
Dipam Vasani                     2           189              0            0.17
Dusan Drevicky                   4           133              9            0.13
Edward Williams                  2           546             21            0.52
Ethan Harris                     1           475              0            0.44
Fariborz Baghaei Nae             1            94             23            0.11
Frankie Robertson                1             5              6            0.01
Gagan Bhatia                     2           601              2            0.56
Gaurav Chawla                    1            95             21            0.11
GiannisVagionakis                1           289              0            0.27
HT Liu                           1            23              1            0.02
Haswanth Aekula                  1           309              0            0.29
Ihar                             1            60             39            0.09
J. Sebastian Paez                2            60             39            0.09
Jan-Henrik Lambrecht             1           241              1            0.22
Jeff Yang                        5           569             77            0.60
Jirka                           38           755            882            1.51
Jirka Borovec                  140         15105          10816           23.95
Johannes Pitz                    1            35             21            0.05
Juan Pablo Carzolio              1             3              3            0.01
Justus Schock                    9          5232            828            5.60
Jv Kyle Eclarin                  1           706              0            0.65
Krzysztof Woś                    1             1              1            0.00
Luca Di Liello                  10          4233            707            4.56
Maheshwari Natarajan             4          1180             91            1.17
Marijan Smetko                   1           159              3            0.15
Maxim Grechkin                  12           743            141            0.82
Mona Köhler                      1            20             17            0.03
Mr. Leu                          1            84             54            0.13
Nicki Skafte                    86         14219           4187           17.00
Nicki Skafte Detlefs            13          1704            620            2.15
Nishant Prabhu                   1             1              1            0.00
Olof Harrysson                   1            22              2            0.02
Paul Grundmann                   1            69             17            0.08
Philip E Blair                   1            33              1            0.03
Pranjal  Datta                   2           409             22            0.40
Pranjal Gulati                   3          1175             43            1.13
Prudhvi Rampey                   1            62             13            0.07
Raj Singh                        1           206              1            0.19
Roger Shieh                      2            16             18            0.03
Rohit Gupta                      3           472            286            0.70
Santiago Castro                  3             3              4            0.01
Scott Cronin                     3            97            124            0.20
Shiv Dhar                        1             1              1            0.00
Sordie                           1            37              7            0.04
Stephen Malina                   1           313              1            0.29
Tadej Svetina                    6          3466            661            3.81
Teddy Koker                      7           465            182            0.60
Tobias Kupek                     7           893             40            0.86
Tony                             1             8              8            0.01
Travis Addair                    1            34             13            0.04
Tri Dao                          1            16             11            0.02
Vatsalya Chaubey                 1           101              6            0.10
William Falcon                   7           762             42            0.74
XFarooqi                         1            68             84            0.14
Xavier Holt                      1             1              1            0.00
Xavier Sumba                     3           464             37            0.46
Xingdong Zuo                     1             1              2            0.00
Yasser Souri                     1             3              9            0.01
Yigit Ozen                       1             1              1            0.00
Younghun Roh                     2            75             26            0.09
ananthsub                        2            43              2            0.04
arvindmuralie77                  1           447             28            0.44
bibinwils                        1             1              1            0.00
deepsource-autofix[b            12            83             92            0.16
deng-cy                          1           455            151            0.56
discort                          1            16              1            0.02
edenlightning                    2            13             17            0.03
elias-ramzi                      1             8              7            0.01
hlin09                           1            30              1            0.03
hugoperrin                       1           270              0            0.25
j-dsouza                         1           127              2            0.12
jirka                            3             7             13            0.02
karthikrangasai                  5          2642            407            2.82
kingyiusuen                      1           150            103            0.23
manipopopo                       2           208             48            0.24
prajakta0111                     1            15              1            0.01
puhuk                            1           112             45            0.15
pwwang                           1             3              3            0.01
quancs                           7          2691             13            2.50
ramonemiliani93                  1            80             28            0.10
simran2905                       1             2              0            0.00
thomas chaton                    6           416             76            0.45
thomasgaudelet                   1            51             34            0.08
twsl                             2           513            243            0.70
victorjoos                       1            30             20            0.05
yuntai                           1            71             34            0.10

Below are the number of rows from each author that have survived and are still
intact in the current revision:

Author                     Rows      Stability          Age       % in comments
Abhinav Gupta                 5           26.3          0.0               20.00
Akihiro Nitta               165          257.8          6.4                0.00
Alexander Senov              49           96.1          5.1                4.08
Ananya Harsh Jha            712           39.5          0.0                3.79
Anselm Coogan               186           88.6          7.2                8.06
Arnaud Gelas                 29           18.5         12.1                0.00
Artur Jaroszewicz            34           73.9          5.9               11.76
Arvind Muralie             1123          147.8          8.8                4.81
Ashutosh Kumar              547           71.9          0.5                0.73
Bhadresh Savani             261           60.3          7.9                4.21
Björn Barz                   57          100.0          1.7               10.53
Celyn Walters                88           92.6          0.3               19.32
Daniel Stancl              4508           77.7          2.4               11.34
Davide Fiocco                27          100.0          9.7                0.00
Dipam Vasani                181           95.8         10.4                0.00
Edward Williams             483           88.5          5.5               11.80
Ethan Harris                404           85.1          9.9               11.39
Fariborz Baghaei Nae         81           86.2          0.3                4.94
Gagan Bhatia                269           44.8          5.6               24.91
Gaurav Chawla                89           93.7          0.3                4.49
GiannisVagionakis           254           87.9          6.8               17.32
Haswanth Aekula             263           85.1          6.8               16.35
Ihar                         52           86.7          8.6                7.69
J. Sebastian Paez            39           65.0          9.8                0.00
Jan-Henrik Lambrecht        235           97.5          2.1               11.49
Jeff Yang                    17            3.0          0.0                0.00
Jirka Borovec              8519           56.4          5.5               15.76
Johannes Pitz                25           71.4          8.1                0.00
Juan Pablo Carzolio           2           66.7          0.0                0.00
Justus Schock               580           11.1         10.2                3.62
Jv Kyle Eclarin             706          100.0          0.3               21.25
Luca Di Liello             3154           74.5          7.4               12.56
Maheshwari Natarajan        865           73.3          2.2               19.42
Maxim Grechkin              613           82.5          9.1                7.99
Mona Köhler                  20          100.0          0.3                0.00
Mr. Leu                      32           38.1          1.5                6.25
Nicki Skafte               8871           62.4          5.8               11.67
Nishant Prabhu                1          100.0          4.9                0.00
Olof Harrysson               21           95.5          1.2                4.76
Paul Grundmann               50           72.5          5.8               16.00
Philip E Blair               26           78.8         11.0               15.38
Pranjal  Datta              313           76.5          9.5               16.29
Pranjal Gulati             1058           90.0          5.6                9.55
Raj Singh                   177           85.9          5.6               21.47
Santiago Castro               2           66.7          5.0                0.00
Scott Cronin                 74           76.3          0.3                0.00
Stephen Malina              307           98.1          3.9                6.19
Tadej Svetina              2041           58.9          8.4                7.74
Teddy Koker                 209           44.9          3.9                6.22
Tobias Kupek                604           67.6          2.7               14.74
Tony                          8          100.0          5.6                0.00
Travis Addair                19           55.9          0.0                0.00
Vatsalya Chaubey             86           85.1          5.6                1.16
William Falcon              131           17.2          0.0               99.24
XFarooqi                     64           94.1          4.0               18.75
Xavier Holt                   1          100.0          3.3                0.00
Xavier Sumba                175           37.7          0.3                4.57
Xingdong Zuo                  1          100.0          1.9                0.00
Yasser Souri                  3          100.0          4.8                0.00
ananthsub                     3            7.0          1.8                0.00
bibinwils                     1          100.0          3.0                0.00
deepsource-autofix[b         72           86.7          7.0                0.00
deng-cy                     180           39.6         12.4               27.22
discort                      12           75.0          5.9                0.00
edenlightning                 7           53.8         10.4               14.29
hlin09                       25           83.3          8.8                0.00
hugoperrin                  219           81.1          6.2               15.98
karthikrangasai            1951           73.8          4.3               13.69
kingyiusuen                  49           32.7          5.1               12.24
manipopopo                  130           62.5         11.2               21.54
prajakta0111                  4           26.7         10.7                0.00
puhuk                        95           84.8          0.3                9.47
quancs                     2193           81.5          4.4               17.56
ramonemiliani93              80          100.0          0.0                6.25
simran2905                    2          100.0          7.0                0.00
thomas chaton               323           77.6          7.2                8.36
thomasgaudelet               33           64.7         10.2                0.00
twsl                        501           97.7          1.5                7.78
victorjoos                   26           86.7          9.8                0.00
yuntai                       10           14.1         11.6                0.00

@whedon
Copy link
Author

whedon commented Jan 27, 2022

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- None

MISSING DOIs

- 10.1163/1574-9347_bnp_e612900 may be a valid DOI for title: Keras

INVALID DOIs

- None

@Borda
Copy link

Borda commented Jan 27, 2022

not sure if it is important, but the actual version is v0.7.0

@inpefess
Copy link

'Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.' --> Lightning-AI/torchmetrics#808

@Borda
Copy link

Borda commented Jan 28, 2022

'Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.' --> PyTorchLightning/metrics#808

yes, the problem seems to be related to PyTorch as they do not provide binaries for python 3.10 yet, and moreover, they suggest using their package warehouse... on the other hand, all shall be well working in the Conda environment >> https://anaconda.org/conda-forge/torchmetrics

cc: @justusschock

@justusschock
Copy link

@taless474 is there a way to have authors without affiliations (@maximsch2 chose not to have an affiliation here)?

@taless474
Copy link

@justusschock yes, authors without affiliations are allowed

@danielskatz
Copy link

danielskatz commented Jan 28, 2022

No, they are not, at least not in the paper processing. See affiliation 3 in https://joss.readthedocs.io/en/latest/submitting.html#example-paper-and-bibliography for how to handle this situation.

@taless474
Copy link

Thank you @danielskatz
@justusschock I think they can go with "Independent Researcher" as shown above

@inpefess
Copy link

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Jan 31, 2022

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

@Borda
Copy link

Borda commented Feb 1, 2022

FYI, both changes Lightning-AI/torchmetrics#810 and Lightning-AI/torchmetrics#817 were cherry-picked and will be released in the next v0.7.1 in meantime you can install the stable from branch release/0.7.x

@reneraab
Copy link

reneraab commented Feb 1, 2022

The software paper gives a good introduction to TorchMetrics and contains all the required sections. However, overall it may be made slightly more accessible for non-specialist audiences. Since this is my first JOSS review, I can't quite judge how accessible JOSS papers typically are and would leave this judgment to the other reviewers. In terms of language I would suggest the following changes:

line 16 in PDF (56 in paper.md): Change "an code and data section" to "a code and data section"
line 16-17 (56): "that links to both official and community code to papers". Remove "to" before both (or rephrase the sentence).
line 17 (56): Change "on the paper code made publicly accessible" to "on the paper code to be made publicly accessible"
line 19 (56): Change "non opensource work" to "closed-source work" or "proprietary work"

line 54 (96): "trained on hundreds of devices GPUs or TPUs". Either remove "GPUs or TPUs" or add "such as" before "GPUs": "trained on hundreds of devices such as GPUs or TPUs".

line 60 (98): The first sentence introduces "a functional interface" and the next sentence uses "they" to refer to the functions that this interface provides. This is not immediately obvious language-wise. Consider rephrasing the second sentence to "This interface provides simple Python functions that"
line 60 (98): Same sentence: capitalize "python functions" to "Python functions.

@Borda
Copy link

Borda commented Feb 1, 2022

@reneraab thank you for your kind suggestions, all shall be implemented in Lightning-AI/torchmetrics#819

@whedon
Copy link
Author

whedon commented Feb 10, 2022

Attempting dry run of processing paper acceptance...

@whedon whedon added the recommend-accept Papers recommended for acceptance in JOSS. label Feb 10, 2022
@whedon
Copy link
Author

whedon commented Feb 10, 2022

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- None

MISSING DOIs

- 10.1163/1574-9347_bnp_e612900 may be a valid DOI for title: Keras

INVALID DOIs

- None

@whedon
Copy link
Author

whedon commented Feb 10, 2022

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

Check final proof 👉 openjournals/joss-papers#2939

If the paper PDF and Crossref deposit XML look good in openjournals/joss-papers#2939, then you can now move forward with accepting the submission by compiling again with the flag deposit=true e.g.

@whedon accept deposit=true

@taless474
Copy link

@justusschock just one thing, the zenodo archive has a different title and authors than the paper. Typically, these are the same for a JOSS-related paper. Note that you can manually change the metadata of the zenodo archive.

@Borda
Copy link

Borda commented Feb 10, 2022

The zendo points to the latest release so it seems that the title will always change according to the release name which is rather dependent on the particular release content... also for having the last edit from Lightning-AI/torchmetrics#830 in a release we would need to make one more v0.7.2 which we can then name exactly as the paper title... 🐰

@justusschock do you know how to change the zenodo manually?

You can cite all versions by using the DOI 10.5281/zenodo.5844769. This DOI represents all versions, and will always resolve to the latest one.

updated in the repo

@justusschock
Copy link

@whedon set v0.7.2 as version

@whedon
Copy link
Author

whedon commented Feb 10, 2022

I'm sorry @justusschock, I'm afraid I can't do that. That's something only editors are allowed to do.

@justusschock
Copy link

justusschock commented Feb 10, 2022

@taless474 We just released v0.7.2 to address this (and also release all the changes of this review process!) together with the new zenodo doi 10.5281/zenodo.6037875. I'm afraid, I don't have permissions to change this, so I would kindly ask you to do so :)

@kthyng
Copy link

kthyng commented Feb 10, 2022

@whedon set archive as 10.5281/zenodo.6037875

@whedon
Copy link
Author

whedon commented Feb 10, 2022

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

@whedon commands

@kthyng
Copy link

kthyng commented Feb 10, 2022

@whedon set 10.5281/zenodo.6037875 as archive

@whedon
Copy link
Author

whedon commented Feb 10, 2022

OK. 10.5281/zenodo.6037875 is the archive.

@kthyng
Copy link

kthyng commented Feb 10, 2022

@whedon set v0.7.2 as version

@whedon
Copy link
Author

whedon commented Feb 10, 2022

OK. v0.7.2 is the version.

@kthyng
Copy link

kthyng commented Feb 10, 2022

Hi @justusschock! A few items to wrap up:

  1. version and archive should be updated now ✅
  2. paper:
  • paragraph after the code on pg 2.: the references should be inline not parenthetical, so remove the [] around them.
  • can you check your references for correct capitalization? I'm guessing Heusel et al should have "nash" capitalized since isn't that a name? You can preserve capitalization by putting {} around characters in your .bib file.

@justusschock
Copy link

Hi @kthyng , Thanks a lot!

With your points you are completely correct and they have been addressed in Lightning-AI/torchmetrics#836 .

Anything else we need to do on this?

@kthyng
Copy link

kthyng commented Feb 11, 2022

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Feb 11, 2022

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

@kthyng
Copy link

kthyng commented Feb 11, 2022

ok looks good!

@kthyng
Copy link

kthyng commented Feb 11, 2022

@whedon accept deposit=true

@whedon
Copy link
Author

whedon commented Feb 11, 2022

Doing it live! Attempting automated processing of paper acceptance...

@whedon whedon added accepted published Papers published in JOSS labels Feb 11, 2022
@whedon
Copy link
Author

whedon commented Feb 11, 2022

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

@whedon
Copy link
Author

whedon commented Feb 11, 2022

🚨🚨🚨 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.04101 joss-papers#2946
  2. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.04101
  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...

@kthyng
Copy link

kthyng commented Feb 11, 2022

Congratulations on your new publication @justusschock! Many thanks to editor @taless474 and reviewers @inpefess, @richrobe, and @reneraab for your time, hard work, and expertise!!

@kthyng kthyng closed this as completed Feb 11, 2022
@whedon
Copy link
Author

whedon commented Feb 11, 2022

🎉🎉🎉 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.04101/status.svg)](https://doi.org/10.21105/joss.04101)

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

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

This is how it will look in your documentation:

DOI

We need your help!

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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted Makefile published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review
Projects
None yet
Development

No branches or pull requests

9 participants