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]: DEEPaaS API: a REST API for Machine Learning and Deep Learning models #1517

Closed
35 of 54 tasks
whedon opened this issue Jun 21, 2019 · 95 comments
Closed
35 of 54 tasks
Assignees
Labels
accepted published Papers published in JOSS recommend-accept Papers recommended for acceptance in JOSS. review

Comments

@whedon
Copy link

whedon commented Jun 21, 2019

Submitting author: @alvarolopez (Álvaro López García)
Repository: https://github.com/indigo-dc/DEEPaaS
Version: 0.5.2
Editor: @trallard
Reviewer: @krother, @rougier
Archive: 10.5281/zenodo.3519350

Status

status

Status badge code:

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

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

@dangunter & @krother & @rougier, 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 @trallard know.

Please try and complete your review in the next two weeks

Review checklist for @dangunter

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: 0.5.2
  • Authorship: Has the submitting author (@alvarolopez) 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 @krother

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: 0.5.2
  • Authorship: Has the submitting author (@alvarolopez) 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 @rougier

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: 0.5.2
  • Authorship: Has the submitting author (@alvarolopez) 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
Copy link
Author

whedon commented Jun 21, 2019

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @dangunter, @krother, @rougier it looks like you're currently assigned to review 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
Copy link
Author

whedon commented Jun 21, 2019

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Jun 21, 2019

@trallard
Copy link
Member

Hey @dangunter, @krother, @rougier thanks a lot for offering to review this submission.

Each of you have been assigned a checklist for your review, please go over the items and check them if you consider them to be satisfied.
Please use this issue for ongoing discussions. If you need to start a longer discussion or request please make an issue on the submission repo and reference it here.

If you encounter any issues or have questions, please feel free to ping me here.

Thanks again for your help 🙏🏼

@trallard
Copy link
Member

trallard commented Jul 1, 2019

@whedon remind @rougier in 2 weeks

@whedon
Copy link
Author

whedon commented Jul 1, 2019

Reminder set for @rougier in 2 weeks

@trallard
Copy link
Member

trallard commented Jul 1, 2019

Hi @krother @dangunter I am just popping by to see how the review is going and check if you need additional help

@whedon
Copy link
Author

whedon commented Jul 15, 2019

👋 @rougier, please update us on how your review is going.

@rougier
Copy link

rougier commented Jul 16, 2019

Thanks for the reminder. I will try to finish by the end of the week.

@rougier
Copy link

rougier commented Jul 16, 2019

@trallard Can we have a link to the paper at the top of the thread ? (I cannot find it)

@trallard
Copy link
Member

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Jul 16, 2019

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Jul 16, 2019

@trallard
Copy link
Member

@rougier here is the article 👆🏼

@rougier
Copy link

rougier commented Jul 17, 2019

@alvarolopez I'm trying to test your software but I have problems because of the gevent package that cannot compile v1.4.0 on my machine (OSX). Last version seems to compile ok but not the 1.4.0. Do you know through which package this dependency comes from ?

@alvarolopez
Copy link

@rougier this is a dependency on DEEPaaS itself, but we are depending on version 1.2.0 (actually I now realise that this can be bumped to 1.3.0).

What error are you obtaining?

@rougier
Copy link

rougier commented Jul 18, 2019

Lots of warnings and errors which make it difficult to track the actual error. Among them:

  src/gevent/libev/gevent.corecext.c:30182:21: error: no member named 'exc_type' in 'struct _ts'
      *type = tstate->exc_type;
              ~~~~~~  ^
  src/gevent/libev/gevent.corecext.c:30183:22: error: no member named 'exc_value' in 'struct _ts'; did you mean 'curexc_value'?
      *value = tstate->exc_value;
                       ^~~~~~~~~

@alvarolopez
Copy link

@Rouger I have fixed this issue, related with an old pinned dependency version and Python3. Version 0.5.0 should work.

@rougier
Copy link

rougier commented Jul 24, 2019

I confirm it fixed my problem.

@rougier
Copy link

rougier commented Jul 24, 2019

@alvarolopez I think you're missing some DOI in the references of your paper. Also, I did not find any way to test the package. Would you that be possible to have a step by step description of a minimal test to run?

@trallard
Copy link
Member

Thanks all for the reviews.
@dangunter, @krother can I have an estimated date for this review to be completed? it has been going on for a while and we'd like to move it forwards

@alvarolopez
Copy link

alvarolopez commented Sep 4, 2019

Hi @rougier, catching up after summer break.

I will correct the DOIs as soon as possible.

Regarding the instructions to run the API is to use the "make develop" command, documented here I reckon that docs must be updated properly, with more detailed information. Currently there is more information on how to run it in the project-wide documentation here.

If you want to test a real model that is integrated with the API, you can have a loot at here.

@trallard
Copy link
Member

Hi folks, just checking in to see how is the review moving? @alvarolopez

@alvarolopez
Copy link

@trallard I've fixed the missing DOI in several publications, under the paper branch.

@alvarolopez
Copy link

@kthyng 🤦‍♂️ yes indeed. I forgot to create the release for that version.

@kthyng
Copy link

kthyng commented Oct 25, 2019

@whedon accept

@whedon
Copy link
Author

whedon commented Oct 25, 2019

No archive DOI set. Exiting...

@kthyng
Copy link

kthyng commented Oct 25, 2019

Oh right

@kthyng
Copy link

kthyng commented Oct 25, 2019

@whedon set 10.5281/zenodo.3519350 as archive

@whedon
Copy link
Author

whedon commented Oct 25, 2019

OK. 10.5281/zenodo.3519350 is the archive.

@kthyng
Copy link

kthyng commented Oct 25, 2019

@whedon accept

@whedon
Copy link
Author

whedon commented Oct 25, 2019

Attempting dry run of processing paper acceptance...

@whedon
Copy link
Author

whedon commented Oct 25, 2019


OK DOIs

- 10.1007/s10462-018-09679-z is OK
- 10.1126/science.1110411 is OK
- 10.1016/j.dss.2012.05.045 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@whedon
Copy link
Author

whedon commented Oct 25, 2019

Check final proof 👉 openjournals/joss-papers#1055

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

@whedon accept deposit=true

@kthyng
Copy link

kthyng commented Oct 25, 2019

@whedon accept deposit=true

@whedon
Copy link
Author

whedon commented Oct 25, 2019

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

@whedon
Copy link
Author

whedon commented Oct 25, 2019

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

@whedon
Copy link
Author

whedon commented Oct 25, 2019

🚨🚨🚨 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.01517 joss-papers#1056
  2. Wait a couple of minutes to verify that the paper DOI resolves https://doi.org/10.21105/joss.01517
  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 Oct 25, 2019

Congrats @alvarolopez on your new paper!!

Many thanks to @krother and @rougier for your time and expertise reviewing, and to @trallard for editing!

@kthyng
Copy link

kthyng commented Oct 25, 2019

@arfon I just realized that the final paper still lists as a reviewer someone who ended up not participated but is still listed. Can we remove them?

@arfon
Copy link
Member

arfon commented Oct 26, 2019

@arfon I just realized that the final paper still lists as a reviewer someone who ended up not participated but is still listed. Can we remove them?

Sure thing, I can fix that.

@arfon
Copy link
Member

arfon commented Oct 26, 2019

OK done!

@alvarolopez
Copy link

@trallard @kthyng @krother @rougier thanks for taking care of the whole process.

@arfon: I just realized that my surname and name are not correctly identified. My name is "Álvaro" and surname is "López García" (i.e. I have two surnames). Can this be fixed?

Many thanks in advance.

@arfon
Copy link
Member

arfon commented Oct 28, 2019

@arfon: I just realized that my surname and name are not correctly identified. My name is "Álvaro" and surname is "López García" (i.e. I have two surnames). Can this be fixed?

Sorry about that @alvarolopez. That should be fixed now. If the PDF on the JOSS site is still looking out of date it might take a while to refresh as there's caching in place.

@arfon arfon closed this as completed Oct 28, 2019
@whedon
Copy link
Author

whedon commented Oct 28, 2019

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

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

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

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:

@kthyng
Copy link

kthyng commented Oct 28, 2019

Thanks @arfon! Sorry for all the after-changes.

@alvarolopez
Copy link

@arfon, many thanks!

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

No branches or pull requests

8 participants