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]: DmpBbo: A versatile Python/C++ library for Function Approximation, Dynamical Movement Primitives, and Black-Box Optimization #1225

Open
whedon opened this Issue Feb 1, 2019 · 50 comments

Comments

Projects
None yet
7 participants
@whedon
Copy link
Collaborator

whedon commented Feb 1, 2019

Submitting author: @graiola (Gennaro Raiola)
Repository: https://github.com/stulp/dmpbbo
Version: v0.7-beta
Editor: @danielskatz
Reviewer: @studywolf, @jenskober
Archive: Pending

Status

status

Status badge code:

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

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

@studywolf & @jenskober, 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.theoj.org/about#reviewer_guidelines. Any questions/concerns please let @danielskatz know.

Please try and complete your review in the next two weeks

Review checklist for @studywolf

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?
  • Version: Does the release version given match the GitHub release ( v0.7-beta)?
  • Authorship: Has the submitting author (@graiola) 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

Software paper

  • Authors: Does the paper.md 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)?

Review checklist for @jenskober

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?
  • Version: Does the release version given match the GitHub release ( v0.7-beta)?
  • Authorship: Has the submitting author (@graiola) 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

Software paper

  • Authors: Does the paper.md 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)?
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Feb 1, 2019

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @studywolf, it looks like you're currently assigned as the reviewer for this paper 🎉.

⭐️ 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
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Feb 1, 2019

Attempting PDF compilation. Reticulating splines etc...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Feb 1, 2019

@danielskatz

This comment has been minimized.

Copy link
Collaborator

danielskatz commented Feb 1, 2019

👋 @studywolf & @jenskober - thanks for agreeing to review.

I'll note here that we expect a couple of weeks delay until this gets started.

When you are ready to start, please see the comment above - your job is basically to review the paper and software according to your checklists, checking off items as they are deemed ok, and making either short comments or more detailed comments in the code repository as you find problems that need to be addressed by the author.

@danielskatz

This comment has been minimized.

Copy link
Collaborator

danielskatz commented Feb 18, 2019

👋 @studywolf & @jenskober - Please go ahead and start this review when you are able to do so

@studywolf

This comment has been minimized.

Copy link
Collaborator

studywolf commented Feb 18, 2019

@danielskatz

This comment has been minimized.

Copy link
Collaborator

danielskatz commented Feb 27, 2019

@jenskober - How are you doing with your review?

@jenskober

This comment has been minimized.

Copy link
Collaborator

jenskober commented Feb 27, 2019

@danielskatz

This comment has been minimized.

Copy link
Collaborator

danielskatz commented Mar 5, 2019

Hi - I'm going to be on vacation for 2 1/2 weeks, so I'm shifting the editor of this submission to be @arfon, during that period - thanks @arfon

@danielskatz

This comment has been minimized.

Copy link
Collaborator

danielskatz commented Mar 5, 2019

@whedon assign @arfon as editor

@studywolf

This comment has been minimized.

Copy link
Collaborator

studywolf commented Mar 10, 2019

regarding the authorship checkbox, Gennaro Raiola has contributed about 1k vs 120k lines of code from Freek Stulp according to the commit history. I'm not sure exactly what the requirements for 'major contribution' are, but the authorship on the paper reflects Freek Stulp as primary author so I'm checking this box as complete.

Edit: It is odd though that the bibtex citation in the README does not list Gennaro Raiola as an author.

@studywolf

This comment has been minimized.

Copy link
Collaborator

studywolf commented Mar 10, 2019

didn't see what versions are python are supported. leaving Installation instructions unchecked until stulp/dmpbbo#28 resolved

edit: base conda install of python requires matplotlib to run demos

@graiola

This comment has been minimized.

Copy link

graiola commented Mar 13, 2019

@studywolf, the issue stulp/dmpbbo#28 should be fixed now.

@jenskober

This comment has been minimized.

@jenskober

This comment has been minimized.

Copy link
Collaborator

jenskober commented Mar 14, 2019

and a few little issues with the demos and tests
stulp/dmpbbo#31

@graiola

This comment has been minimized.

Copy link

graiola commented Mar 14, 2019

@jenskober I fixed the missing DOIs, thanks.

@jenskober

This comment has been minimized.

Copy link
Collaborator

jenskober commented Mar 14, 2019

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Mar 14, 2019

Attempting PDF compilation. Reticulating splines etc...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Mar 14, 2019

@stulp

This comment has been minimized.

Copy link

stulp commented Mar 14, 2019

and a few little issues with the demos and tests
stulp/dmpbbo#31

I've taken the liberty of splitting your issue stulp/dmpbbo#31 into smaller ones 32-40, so that we can assign & conquer. As the other ones are now open, I've closed stulp/dmpbbo#31.

@stulp

This comment has been minimized.

Copy link

stulp commented Mar 16, 2019

Here is a small update. Based on the feedback from the reviewers, following larger modifications have been made (apart from smaller bugfixes). These modifications are related to the demos and tests in the C++ version, not the core library.

  • The executables and Python wrappers were in different directories which was confusing. They are now installed in the demos/ directory so that they are together.

  • Demos are now documented in README.md files in the subdirectories of the demos/ directory. Again, this is to have everything in one place, and allow users to understand and run demos without calling doxygen (doxygen documentation is now only for the API of the libraries in the src/ directory)

  • When running the demos, the data is no longer stored in /tmp, but in the demos/ directory itself. This ensures that everything is in one place, makes it more transparent that data is being written, and allows the user to have a look at the generated data on the spot.

  • Tests in dmpbbo are not unit test but programs used for development. They are no longer installed in bin_test to avoid confusion about this.

  • INSTALL.txt has been rewritten and improved into INSTALL.md

@jenskober

This comment has been minimized.

Copy link
Collaborator

jenskober commented Mar 19, 2019

@stulp Thanks for all the updates, looks great now from my side.

@graiola One last thing about the paper itself: if you check the article proof above, on the second page in applications you have "(Stulp,2012,Stulp et al. (2013),stulp14simultaneous,Stulp & Sigaud (2015))" "stulp14simultaneous" is missing in the references, the first one "Stulp,2012" looks strange as well, and a few spaces after the commas (also first page "(A. J. Ijspeert, Nakanishi, & Schaal, 2002,A. Ijspeert, Nakanishi, Pastor, Hoffmann, & Schaal (2013))") would be nice...

@graiola

This comment has been minimized.

Copy link

graiola commented Mar 19, 2019

Thanks @jenskober , I will look into it now.

@graiola

This comment has been minimized.

Copy link

graiola commented Mar 19, 2019

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Mar 19, 2019

Attempting PDF compilation. Reticulating splines etc...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Mar 19, 2019

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

/app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-01ece1d1d135/lib/whedon/author.rb:58:in block in build_affiliation_string': Problem with affiliations for Freek Stulp, perhaps the affiliations index need quoting? (RuntimeError) from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-01ece1d1d135/lib/whedon/author.rb:57:in each'
from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-01ece1d1d135/lib/whedon/author.rb:57:in build_affiliation_string' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-01ece1d1d135/lib/whedon/author.rb:17:in initialize'
from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-01ece1d1d135/lib/whedon.rb:109:in new' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-01ece1d1d135/lib/whedon.rb:109:in block in parse_authors'
from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-01ece1d1d135/lib/whedon.rb:106:in each' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-01ece1d1d135/lib/whedon.rb:106:in parse_authors'
from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-01ece1d1d135/lib/whedon.rb:73:in initialize' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-01ece1d1d135/lib/whedon/processor.rb:32:in new'
from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-01ece1d1d135/lib/whedon/processor.rb:32:in set_paper' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-01ece1d1d135/bin/whedon:55:in prepare'
from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor/command.rb:27:in run' from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor/invocation.rb:126:in invoke_command'
from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor.rb:387:in dispatch' from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor/base.rb:466:in start'
from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-01ece1d1d135/bin/whedon:116:in <top (required)>' from /app/vendor/bundle/ruby/2.4.0/bin/whedon:23:in load'
from /app/vendor/bundle/ruby/2.4.0/bin/whedon:23:in `

'

@graiola

This comment has been minimized.

Copy link

graiola commented Mar 19, 2019

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Mar 19, 2019

Attempting PDF compilation. Reticulating splines etc...
@whedon

This comment has been minimized.

Copy link
Collaborator Author

whedon commented Mar 19, 2019

@jenskober

This comment has been minimized.

Copy link
Collaborator

jenskober commented Mar 19, 2019

@arfon @studywolf I'm done with my review.

@arfon

This comment has been minimized.

Copy link
Member

arfon commented Mar 19, 2019

@arfon @studywolf I'm done with my review.

Great! It looks like there's a number of checkboxes that aren't ticked - could you please take another look at them and tick what you can given you review?

@jenskober

This comment has been minimized.

Copy link
Collaborator

jenskober commented Mar 19, 2019

Hmm, as far as I can see all mine are checked. @studywolf still has some that are not checked.

@arfon

This comment has been minimized.

Copy link
Member

arfon commented Mar 19, 2019

Hmm, as far as I can see all mine are checked. @studywolf still has some that are not checked.

You're right. Apologies. @studywolf - how are you getting along with your review?

@studywolf

This comment has been minimized.

Copy link
Collaborator

studywolf commented Mar 27, 2019

Sorry about the delay, I didn't get these notification reminders for some reason. Things have been hectic! I will try to finish the review tonight / tomorrow though.

@studywolf

This comment has been minimized.

Copy link
Collaborator

studywolf commented Mar 27, 2019

a few issues submitted to the repo as i was going through the examples. I haven't fully confirmed the functionality or looked at the functionality documentation.

There are no unit tests for checking off the 'automated tests' box, I see it was mentioned above but didn't see it specifically addressed. What's the resolution on this?

@danielskatz

This comment has been minimized.

Copy link
Collaborator

danielskatz commented Mar 27, 2019

@whedon assign @danielskatz as editor

@danielskatz

This comment has been minimized.

Copy link
Collaborator

danielskatz commented Mar 27, 2019

thanks for the help while I was out @arfon

@danielskatz

This comment has been minimized.

Copy link
Collaborator

danielskatz commented Mar 27, 2019

There are no unit tests for checking off the 'automated tests' box, I see it was mentioned above but didn't see it specifically addressed. What's the resolution on this?

The test do not need need to be automated, but there do need to be some tests. If there are tests, please check it off. If there are no tests at all, some need to be added

@danielskatz

This comment has been minimized.

Copy link
Collaborator

danielskatz commented Mar 27, 2019

@whedon assign @danielskatz as editor

@studywolf

This comment has been minimized.

Copy link
Collaborator

studywolf commented Mar 27, 2019

Check it off if there are any tests at all? Or are we looking for some amount of functionality coverage?

@danielskatz

This comment has been minimized.

Copy link
Collaborator

danielskatz commented Mar 27, 2019

I would say minimal functionality tests - something that verifies the basic functionality

@danielskatz

This comment has been minimized.

Copy link
Collaborator

danielskatz commented Apr 7, 2019

👋 @studywolf - How is the review going? What's currently blocking you?

@studywolf

This comment has been minimized.

Copy link
Collaborator

studywolf commented Apr 9, 2019

Was able to check off a few more, mostly available time is blocking me. I had one remaining issue on the repo (and just raised another), should I not be waiting for them to be resolved before checking off the corresponding box?

@studywolf

This comment has been minimized.

Copy link
Collaborator

studywolf commented Apr 14, 2019

@danielskatz i've completed the review, and with the contributing documentation added it looks good aside from the documentation for one part of the code. This is currently an open issue on the github, so deferring to you on this. If you think it's fine to not have this resolved before approving then 👍

@danielskatz

This comment has been minimized.

Copy link
Collaborator

danielskatz commented Apr 14, 2019

Let's go ahead at this point.

@danielskatz

This comment has been minimized.

Copy link
Collaborator

danielskatz commented Apr 14, 2019

👋 @graiola - what is the current version number?

And please make sure there is an archive of the current version, and let me know the DOI for it as well.

@danielskatz

This comment has been minimized.

Copy link
Collaborator

danielskatz commented Apr 14, 2019

Thanks very much, @studywolf and @jenskober for your reviews!

@stulp

This comment has been minimized.

Copy link

stulp commented Apr 15, 2019

It would be nice if I could close issue 44 (which was opened by @studywolf) before assigning the next version number. That is the version I would like the DOI to be assigned with.

Fixing 44 is quite a bit of work (involving an overhaul of the serialization functions), but I should be done within a week or so. @danielskatz, would it be possible to wait with the acceptance until I have fixed it?

@danielskatz

This comment has been minimized.

Copy link
Collaborator

danielskatz commented Apr 15, 2019

If it's that close to done, then yes, let's wait. My suggestion to go ahead was based on an assumption it would take longer.

@danielskatz

This comment has been minimized.

Copy link
Collaborator

danielskatz commented Apr 15, 2019

When you make the new version, please make the changes clear so one of us can quickly review them as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.