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]: ProbabilityBoundsAnalysis.jl: theory and algorithms #96

Closed
22 of 42 tasks
whedon opened this issue Oct 22, 2021 · 62 comments
Closed
22 of 42 tasks

[REVIEW]: ProbabilityBoundsAnalysis.jl: theory and algorithms #96

whedon opened this issue Oct 22, 2021 · 62 comments
Assignees

Comments

@whedon
Copy link
Collaborator

whedon commented Oct 22, 2021

Submitting author: @AnderGray (Ander Gray)
Repository: https://github.com/AnderGray/ProbabilityBoundsAnalysis.jl
Branch with paper.md (empty if default branch):
Version:
Editor: @carstenbauer
Reviewers: @dpsanders, @baggepinnen
Archive: Pending

Status

status

Status badge code:

HTML: <a href="https://proceedings.juliacon.org/papers/41644cd3e3844116d843e5efa1a5cd30"><img src="https://proceedings.juliacon.org/papers/41644cd3e3844116d843e5efa1a5cd30/status.svg"></a>
Markdown: [![status](https://proceedings.juliacon.org/papers/41644cd3e3844116d843e5efa1a5cd30/status.svg)](https://proceedings.juliacon.org/papers/41644cd3e3844116d843e5efa1a5cd30)

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

@dpsanders & @baggepinnen, 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 @carstenbauer 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 @dpsanders

Conflict of interest

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?
  • Authorship: Has the submitting author (@AnderGray) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

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 function 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

Paper format

  • Authors: Does the paper.tex file include a list of authors with their affiliations?
  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • References: Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?
  • Page limit: Is the page limit for full papers respected by the submitted document?

Content

  • Context: is the scientific context motivating the work correctly presented?
  • Methodology: is the approach taken in the work justified, presented with enough details and reference to reproduce it?
  • Results: are the results presented and compared to approaches with similar goals?

Review checklist for @baggepinnen

Conflict of interest

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?
  • Authorship: Has the submitting author (@AnderGray) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

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 function 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

Paper format

  • Authors: Does the paper.tex file include a list of authors with their affiliations?
  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • References: Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?
  • Page limit: Is the page limit for full papers respected by the submitted document?

Content

  • Context: is the scientific context motivating the work correctly presented?
  • Methodology: is the approach taken in the work justified, presented with enough details and reference to reproduce it?
  • Results: are the results presented and compared to approaches with similar goals?
@whedon
Copy link
Collaborator Author

whedon commented Oct 22, 2021

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @dpsanders, @baggepinnen 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/JuliaCon/proceedings-review) 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/JuliaCon/proceedings-review:

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
Collaborator Author

whedon commented Oct 22, 2021

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

 Can't find any papers to compile :-(

@carstenbauer
Copy link
Member

@whedon generate pdf from branch JuliaConPaper

@whedon
Copy link
Collaborator Author

whedon commented Oct 22, 2021

Attempting PDF compilation from custom branch JuliaConPaper. Reticulating splines etc...

@whedon
Copy link
Collaborator Author

whedon commented Oct 22, 2021

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

 Can't find any papers to compile :-(

@whedon
Copy link
Collaborator Author

whedon commented Nov 5, 2021

👋 @dpsanders, please update us on how your review is going (this is an automated reminder).

@whedon
Copy link
Collaborator Author

whedon commented Nov 5, 2021

👋 @baggepinnen, please update us on how your review is going (this is an automated reminder).

@AnderGray
Copy link

@whedon generate pdf from branch JuliaConPaper

@whedon
Copy link
Collaborator Author

whedon commented Nov 8, 2021

Attempting PDF compilation from custom branch JuliaConPaper. Reticulating splines etc...

@whedon
Copy link
Collaborator Author

whedon commented Nov 8, 2021

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

 Can't find any papers to compile :-(

@AnderGray
Copy link

@dpsanders @baggepinnen, not sure why it's not finding the paper. I changed the title in the header.tex, could this perhaps have led to some issues? Was it ok to change the title?

Otherwise, a pdf of the paper is uploaded to the branch

@carstenbauer
Copy link
Member

@whedon generate pdf from branch JuliaConPaper

@whedon
Copy link
Collaborator Author

whedon commented Nov 14, 2021

Attempting PDF compilation from custom branch JuliaConPaper. Reticulating splines etc...

@whedon
Copy link
Collaborator Author

whedon commented Nov 14, 2021

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

 Can't find any papers to compile :-(

@carstenbauer
Copy link
Member

@whedon generate pdf

@whedon
Copy link
Collaborator Author

whedon commented Nov 14, 2021

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

 Can't find any papers to compile :-(

@carstenbauer
Copy link
Member

Perhaps the issue here is that the branch information ("JuliaConPaper") is already part of the repo URL (see OP). @vchuravy, can you drop that part and make the repo here simply point to https://github.com/AnderGray/ProbabilityBoundsAnalysis.jl? (I think I can't do it, right?)

@AnderGray In any case, it is better to not have a paper.pdf in the paper/ folder of the JuliaConPaper branch. On the one hand, to not confuse whedon, and on the other hand since the paper isn't published yet.

@AnderGray
Copy link

Hi all, is this still being considered for review?

@baggepinnen
Copy link
Collaborator

I have started my review, but I've been reading the pdf that was deleted from the https://github.com/AnderGray/ProbabilityBoundsAnalysis.jl repo, I couldn't find any other pdf?

@AnderGray
Copy link

Thanks @baggepinnen, I removed it as was suggested.

Here's an upload: PBApaper.pdf

@carstenbauer
Copy link
Member

@whedon generate pdf

@whedon
Copy link
Collaborator Author

whedon commented Jan 7, 2022

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

 Can't find any papers to compile :-(

@carstenbauer
Copy link
Member

@whedon generate pdf

@whedon
Copy link
Collaborator Author

whedon commented Jan 7, 2022

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

 Can't find any papers to compile :-(

@carstenbauer
Copy link
Member

While I try to fix the whedon issue here, @dpsanders and @baggepinnen please let me know how your reviews are going. Would be great if you could finish them within the next few weeks at the latest. Thanks in advance!

@vchuravy

This comment has been minimized.

@whedon

This comment has been minimized.

@dpsanders
Copy link
Collaborator

👋 @AnderGray: It's not clear to me why Eduardo Patelli is an author of the paper, since he does not seem to be an author of the package, according to the docs.

@AnderGray
Copy link

@dpsanders @baggepinnen Thanks both for this review, and for the great suggestions which will improve the quality of package substantially. Apologies I'm taking so long to get back. I'm working on two PRs which address your comments. I've completed David's, and will hopefully finish Fredrik's in the coming week

@AnderGray
Copy link

👋 @AnderGray: It's not clear to me why Eduardo Patelli is an author of the paper, since he does not seem to be an author of the package, according to the docs.

Edoardo Patelli provided funding sourcing and mentorship, without which this package would have not been created, and I believe he should be an author of the paper. I will change the authorship in the Docs

@carstenbauer
Copy link
Member

What's the status here? @AnderGray I see there are still open issues and PRs related to the reviews by @dpsanders and @baggepinnen. Am I right in assuming that you just need more time to improve / fix things?

@AnderGray
Copy link

@carstenbauer Thanks for following this up. Yes, most of the issues have been addressed. @dpsanders's questions have all be addressed I believe, and although the PR was merged (since we wanted this functionality). I've addressed some of @baggepinnen's, the biggest is related to testing, which is taking time. Nearly there

@AnderGray
Copy link

@whedon generate pdf from branch JuliaConPaper

@whedon
Copy link
Collaborator Author

whedon commented Apr 15, 2022

Attempting PDF compilation from custom branch JuliaConPaper. Reticulating splines etc...

@whedon
Copy link
Collaborator Author

whedon commented Apr 15, 2022

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

 Latexmk: This is Latexmk, John Collins, 17 Jan. 2018, version: 4.55.
Rule 'pdflatex': Rules & subrules not known to be previously run:
   pdflatex
Rule 'pdflatex': The following rules & subrules became out-of-date:
      'pdflatex'
------------
Run number 1 of rule 'pdflatex'
------------
------------
Running 'pdflatex  -recorder  "paper.tex"'
------------
===========Latexmk: Missing input file: 'subfig.sty' from line
  '! LaTeX Error: File `subfig.sty' not found.'
Latexmk: Missing input file: 'subfig.sty' from line
  '! LaTeX Error: File `subfig.sty' not found.'
Failure to make 'paper.pdf'
Collected error summary (may duplicate other messages):
  pdflatex: Command for 'pdflatex' gave return code 1
      Refer to 'paper.log' for details
Looks like we failed to compile the PDF

@AnderGray
Copy link

@whedon generate pdf from branch JuliaConPaper

@whedon
Copy link
Collaborator Author

whedon commented Apr 15, 2022

Attempting PDF compilation from custom branch JuliaConPaper. Reticulating splines etc...

@whedon
Copy link
Collaborator Author

whedon commented Apr 15, 2022

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

 Latexmk: This is Latexmk, John Collins, 17 Jan. 2018, version: 4.55.
Rule 'pdflatex': Rules & subrules not known to be previously run:
   pdflatex
Rule 'pdflatex': The following rules & subrules became out-of-date:
      'pdflatex'
------------
Run number 1 of rule 'pdflatex'
------------
------------
Running 'pdflatex  -recorder  "paper.tex"'
------------
Rule 'pdflatex': File changes, etc:
   Changed files, or newly in use since previous run(s):
      'paper.aux'
------------
Run number 2 of rule 'pdflatex'
------------
------------
Running 'pdflatex  -recorder  "paper.tex"'
------------
Rule 'pdflatex': File changes, etc:
   Changed files, or newly in use since previous run(s):
      'paper.out'
------------
Run number 3 of rule 'pdflatex'
------------
------------
Running 'pdflatex  -recorder  "paper.tex"'
------------
Failure to make 'paper.pdf'
Collected error summary (may duplicate other messages):
  pdflatex: Command for 'pdflatex' gave return code 1
      Refer to 'paper.log' for details
Looks like we failed to compile the PDF

@AnderGray
Copy link

AnderGray commented Apr 15, 2022

@baggepinnen @dpsanders apologies for the wait, I think we're ready for another look. Unsure why why the pdf isn't compiling, but I believe I've incorporated the requests. I've added all the DOI's I could find, and shortened the paper.

For @baggepinnen, the PR can be seen in pull/37:

  • Testing improved
  • Documentation improved (included added community guidelines)
  • Added comparisons

Note that unlike intervals, which always return Boolean values (perhaps erroneously), comparisons between p-boxes return interval probabilities, which give the probability that the imprecisely characterise random variables meet the condition. More details can be found in the new docs

Example between p-box and scalars:

julia> X = uniform(0, 1)
julia> X <= 0.7
[0.695, 0.705001]

julia> X >= 0.4
[0.594999, 0.605]

julia> X = normal(interval(-0.5, 0.5), interval(1, 1.5))
julia> X >= 1
[0.0649999, 0.37]

julia> X = uniform(0, 1)
julia> X <= 2
true

julia> X >= 2
false

Example between p-box and intervals

julia> X = uniform(0, 1)
julia> Y = interval(0.7, 2)
julia> X <= Y
[0.695, 1]

julia> X >= Y
[0, 0.305]

julia> X <= interval(2, 3)
true

julia> X >= interval(2, 3)
false

Example between p-boxes

julia> X = uniform(0, 1)
julia> Y = uniform(0.5, 1.5)
julia> X <= Y
[0.5, 1]

julia> X <= uniform(2, 3)
true

julia> X >= uniform(2, 3)
false

Note that this will cause your foo function above to fail due to using a non-Boolean ... I do however believe that this is correct in this context. Evaluate this with intervals [0, 1] <= 0.5 returns false by default, but it could be argued that the interval Boolean [0, 1] is the correct return here, since we cannot say if the interval is above or below the scalar. There is some discussion about this in the introduction in the paper. ProbabilityBoundsAnalysis.jl returns the probability that the condition is met, e.g., uniform(0,1) <= 0.5 gives a tight probability interval [0.494999, 0.505001] (the interval comes from discretisation error bounding).

A warning about this has been added to the docs. Ideally I would like to modify the Julia warning message when an interval (probability) is used in a Boolean context, saying why this is happening. Do you know if it's possible to do this?

For @dpsanders the PR was already merged, but is pull/35. I've also responded to your issues individually, which are still open.

@dpsanders
Copy link
Collaborator

dpsanders commented Apr 15, 2022

There is a massive overhaul of IntervalArithmetic.jl underway which will fix the X < Y issue for intervals X and Y, by allowing the user to specify the behaviour they prefer: see JuliaIntervals/IntervalArithmetic.jl#271 and JuliaIntervals/IntervalArithmetic.jl#514

@AnderGray : Thanks, I'll take a look!

@AnderGray
Copy link

@baggepinnen @dpsanders Hi guys, any updates with this? :)

@AnderGray
Copy link

@baggepinnen @dpsanders @carstenbauer hi fellas, are we still considering this for review?

@carstenbauer
Copy link
Member

@whedon generate pdf from branch JuliaConPaper

@whedon
Copy link
Collaborator Author

whedon commented Jun 9, 2022

Attempting PDF compilation from custom branch JuliaConPaper. Reticulating splines etc...

@whedon
Copy link
Collaborator Author

whedon commented Jun 9, 2022

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

 Latexmk: This is Latexmk, John Collins, 17 Jan. 2018, version: 4.55.
Rule 'pdflatex': Rules & subrules not known to be previously run:
   pdflatex
Rule 'pdflatex': The following rules & subrules became out-of-date:
      'pdflatex'
------------
Run number 1 of rule 'pdflatex'
------------
------------
Running 'pdflatex  -recorder  "paper.tex"'
------------
Rule 'pdflatex': File changes, etc:
   Changed files, or newly in use since previous run(s):
      'paper.aux'
------------
Run number 2 of rule 'pdflatex'
------------
------------
Running 'pdflatex  -recorder  "paper.tex"'
------------
Rule 'pdflatex': File changes, etc:
   Changed files, or newly in use since previous run(s):
      'paper.out'
------------
Run number 3 of rule 'pdflatex'
------------
------------
Running 'pdflatex  -recorder  "paper.tex"'
------------
Failure to make 'paper.pdf'
Collected error summary (may duplicate other messages):
  pdflatex: Command for 'pdflatex' gave return code 1
      Refer to 'paper.log' for details
Looks like we failed to compile the PDF

@AnderGray
Copy link

Hi @carstenbauer @baggepinnen @dpsanders, been over a year since submission. This still being considered, or is it better to resubmit to another journal?

@carstenbauer
Copy link
Member

@whedon generate pdf from branch JuliaConPaper

@whedon
Copy link
Collaborator Author

whedon commented Dec 28, 2022

Attempting PDF compilation from custom branch JuliaConPaper. Reticulating splines etc...

@whedon
Copy link
Collaborator Author

whedon commented Dec 28, 2022

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

 Latexmk: This is Latexmk, John Collins, 17 Jan. 2018, version: 4.55.
Rule 'pdflatex': Rules & subrules not known to be previously run:
   pdflatex
Rule 'pdflatex': The following rules & subrules became out-of-date:
      'pdflatex'
------------
Run number 1 of rule 'pdflatex'
------------
------------
Running 'pdflatex  -recorder  "paper.tex"'
------------
Rule 'pdflatex': File changes, etc:
   Changed files, or newly in use since previous run(s):
      'paper.aux'
------------
Run number 2 of rule 'pdflatex'
------------
------------
Running 'pdflatex  -recorder  "paper.tex"'
------------
Rule 'pdflatex': File changes, etc:
   Changed files, or newly in use since previous run(s):
      'paper.out'
------------
Run number 3 of rule 'pdflatex'
------------
------------
Running 'pdflatex  -recorder  "paper.tex"'
------------
Failure to make 'paper.pdf'
Collected error summary (may duplicate other messages):
  pdflatex: Command for 'pdflatex' gave return code 1
      Refer to 'paper.log' for details
Looks like we failed to compile the PDF

@carstenbauer
Copy link
Member

@AnderGray I apologise sincerely and must admit that I completely forgot about your submission / this issue. Are you willing to continue and move this over the finish line?

If so, it would be great if you could debug the PDF compilation error (Does it work locally? Maybe "rebase" the paper folder to the current version of the submission template.). Afterwards, I'll ask the reviewers to give this another / a final look.

Sorry again.

@carstenbauer
Copy link
Member

Since there hasn't been any response to my last message, I'm closing this. If you want to reopen, please let me know!

@lucaferranti
Copy link
Member

@editorialbot reject

@editorialbot
Copy link
Collaborator

Paper rejected.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

8 participants