[REVIEW]: ECabc: A feature tuning program focused on Artificial Neural Network hyperparameters #1420

whedon · 2019-04-30T22:02:39Z

Submitting author: @sanskriti-s (Sanskriti Sharma)
Repository: https://github.com/ECRL/ecabc
Version: v2.2.2
Editor: @arokem
Reviewer: @annoviko
Archive: 10.5281/zenodo.3256403

Status

Status badge code:

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

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

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

Make sure you're logged in to your GitHub account
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 @arokem know.

✨ Please try and complete your review in the next two weeks ✨

Review checklist for @annoviko

Conflict of interest

As the reviewer I confirm that I have read the JOSS conflict of interest policy and that there are no conflicts of interest for me to review this work.

Code of Conduct

I confirm that I read and will adhere to the JOSS 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 (v2.2.2)?
Authorship: Has the submitting author (@sanskriti-s) 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)?

The text was updated successfully, but these errors were encountered:

whedon · 2019-04-30T22:02:41Z

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @annoviko 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:

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

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

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

@whedon commands

whedon · 2019-04-30T22:02:42Z

Attempting PDF compilation. Reticulating splines etc...

whedon · 2019-04-30T22:03:20Z

👉 Check article proof 📄 👈

annoviko · 2019-05-06T05:48:27Z

@whedon check references

whedon · 2019-05-06T05:48:30Z

Attempting to check references...

whedon · 2019-05-06T05:48:34Z


OK DOIs

- 10.1016/s0925-2312(00)00302-7 is OK
- 10.1109/sami.2015.7061899 is OK
- 10.21105/joss.00401 is OK
- 10.1016/j.fuel.2017.06.015 is OK

MISSING DOIs

- None

INVALID DOIs

- None

annoviko · 2019-05-06T06:03:48Z

Hello, @sanskriti-s
There are several remarks that should be corrected:

Example contains mistakes in README.md (at least it doesn't work for v2.2.2):

Incorrect import, I think from ecabc import * should be instead of from eabc import *, otherwise following exception is obtained:

ImportError: No module named 'eabc'

ABC is not defined:

    abc = ABC(fitness_fxn=idealDayTest,
            value_ranges=values
            )

NameError: name 'ABC' is not defined

Several references does not contains DOI. Could you please add DOI for these references?

@online{ecabc_github,
author = {Sanskriti Sharma},
title = {ECabc: A feature tuning program focused on Artificial Neural Network hyperparameters},
year = {2019},
url = {https://github.com/ECRL/ECabc},
urldate = {2019-04-12}
}

@online{ecabc_pypi,
author = {Sanskriti Sharma, Hernan Gelaf-Romer},
title = {ecabc 2.2.2},
year = {2019},
url = {https://pypi.python.org/pypi/ecabc/},
urldate = {2019-04-12}
}

@online{uml_ecrl,
author = {John Hunter Mack},
title = {Energy and Combustion Research Laboratory},
year = {2019},
url = {http://faculty.uml.edu/Hunter_Mack/},
urldate = {2019-04-12}
}

@book{Hassoun_2009,
Author = {{Hassoun}, M.},
Booktitle = {Fundamentals of Artificial Neural Networks, by Hassoun, Mohamad H.~ISBN 9788120313569 (HB).~Published by PHI Learning, Delhi, India, 2009.},
Publisher = {PHI Learning},
Title = {{Fundamentals of Artificial Neural Networks}},
Year = 2009
}

sanskriti-s · 2019-05-15T17:59:22Z

Hi @annoviko. Sorry for the late response, I had finals. So I fixed the README, but I have a question about the DOIs. To the best of my knowledge online sources don't have DOIs and while books do, I can't find one for the book I have cited. So what should I do about them?

arokem · 2019-05-22T17:40:53Z

Hi @sanskriti-s : you are correct that the websites you refer do not have a DOI, and you do not need to specify one for these. I believe that the Hassoun book does not have a DOI either. So, no need for DOIs for these.

sanskriti-s · 2019-05-23T00:40:18Z

Hi @arokem, Ok thanks

arokem · 2019-05-25T20:37:09Z

@annoviko : any other comments? I see that several of the boxes have not been checked yet.

annoviko · 2019-05-27T11:51:12Z

Hello, @arokem,
Sorry for delay, I have returned from business trip recently. I will finish review during this week.

annoviko · 2019-06-01T11:16:13Z

Hello, @sanskriti-s ,
There is only one unclear moment that is related to testing. I haven't found any tests in the repository and there is no instruction how to verify software. Could you please provide any comments?

sanskriti-s · 2019-06-03T22:41:18Z

Hi @annoviko . The tests are available in the examples directory

annoviko · 2019-06-04T09:23:16Z

Hello, @sanskriti-s ,

I think it should be reflected in the README in line with JOSS's requirements:

Automated tests: Are there automated tests or manual steps described so that the function of the software can be verified?

Could you please add this information (how to verify software functionality) to README?

sanskriti-s · 2019-06-05T01:21:47Z

Hello @annoviko. I have made the changes you requested.

annoviko · 2019-06-10T10:43:32Z

@sanskriti-s , thanks, now everything looks ok.
@arokem, let's move to the next steps.

arokem · 2019-06-13T06:14:46Z

@whedon commands

whedon · 2019-06-13T06:14:48Z

Here are some things you can ask me to do:

# List all of Whedon's capabilities
@whedon commands

# Assign a GitHub user as the sole reviewer of this submission
@whedon assign @username as reviewer

# Add a GitHub user to the reviewers of this submission
@whedon add @username as reviewer

# Remove a GitHub user from the reviewers of this submission
@whedon remove @username as reviewer

# List of editor GitHub usernames
@whedon list editors

# List of reviewers together with programming language preferences and domain expertise
@whedon list reviewers

# Change editorial assignment
@whedon assign @username as editor

# Set the software archive DOI at the top of the issue e.g.
@whedon set 10.0000/zenodo.00000 as archive

# Set the software version at the top of the issue e.g.
@whedon set v1.0.1 as version

# Open the review issue
@whedon start review

EDITORIAL TASKS

# Compile the paper
@whedon generate pdf

# Compile the paper from alternative branch
@whedon generate pdf from branch custom-branch-name

# Remind an author or reviewer to return to a review after a
# certain period of time (supported units days and weeks)
@whedon remind @reviewer in 2 weeks

# Ask Whedon to accept the paper and deposit with Crossref
@whedon accept

# Ask Whedon to check the references for missing DOIs
@whedon check references

arokem · 2019-06-13T06:15:08Z

@whedon generate pdf

whedon · 2019-06-13T06:15:11Z

Attempting PDF compilation. Reticulating splines etc...

whedon · 2019-06-13T06:15:31Z

👉 Check article proof 📄 👈

arokem · 2019-06-13T07:21:14Z

@sanskriti-s : just one request on my end: the caption of Figure one is currently not particularly informative. Would you mind rewriting this caption? Even just "Figure 1: the stages of the algorithm (see text)" or similar would be sufficient.

After that's done, we can proceed with the next steps in accepting the article.

sanskriti-s · 2019-06-20T19:30:54Z

@arokem: Done!

arokem · 2019-06-24T15:58:57Z

@whedon generate pdf

whedon · 2019-06-24T15:59:00Z

Attempting PDF compilation. Reticulating splines etc...

whedon · 2019-07-11T20:13:52Z

👉 Check article proof 📄 👈

kyleniemeyer · 2019-07-11T21:13:42Z

@sanskriti-s I fixed a number of the remaining issues with the paper and references in ecrl/ecabc#47 and ecrl/ecabc#48

When I was asking for affiliation information, I meant your affiliation given in the paper header, not to add institution to each of the references—which is not necessary (or even used).

Also, it looked like you actually removed the citation commands, rather than correcting them as I asked; I fixed those.

Finally, in BibTeX references, author names in author need to be separated by and rather than commas.

kyleniemeyer · 2019-07-11T21:15:35Z

@whedon generate pdf

whedon · 2019-07-11T21:15:38Z

Attempting PDF compilation. Reticulating splines etc...

whedon · 2019-07-11T21:15:57Z

👉 Check article proof 📄 👈

kyleniemeyer · 2019-07-11T21:20:08Z

@sanskriti-s sorry, I missed one reference in the text

kyleniemeyer · 2019-07-11T21:22:05Z

@whedon generate pdf

whedon · 2019-07-11T21:22:09Z

Attempting PDF compilation. Reticulating splines etc...

whedon · 2019-07-11T21:22:26Z

👉 Check article proof 📄 👈

kyleniemeyer · 2019-07-11T21:24:10Z

@sanskriti-s ok, I think we're good to go here!

kyleniemeyer · 2019-07-11T21:25:05Z

@whedon accept

whedon · 2019-07-11T21:25:07Z

Attempting dry run of processing paper acceptance...

whedon · 2019-07-11T21:25:10Z

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

/app/vendor/bundle/ruby/2.4.0/gems/octokit-4.8.0/lib/octokit/response/raise_error.rb:16:in on_complete': GET https://api.github.com/repos/openjournals/joss-reviews-testing/issues/1420: 404 - Not Found // See: https://developer.github.com/v3/issues/#get-a-single-issue (Octokit::NotFound) from /app/vendor/bundle/ruby/2.4.0/gems/faraday-0.14.0/lib/faraday/response.rb:9:in block in call'
from /app/vendor/bundle/ruby/2.4.0/gems/faraday-0.14.0/lib/faraday/response.rb:61:in on_complete' from /app/vendor/bundle/ruby/2.4.0/gems/faraday-0.14.0/lib/faraday/response.rb:8:in call'
from /app/vendor/bundle/ruby/2.4.0/gems/octokit-4.8.0/lib/octokit/middleware/follow_redirects.rb:73:in perform_with_redirection' from /app/vendor/bundle/ruby/2.4.0/gems/octokit-4.8.0/lib/octokit/middleware/follow_redirects.rb:61:in call'
from /app/vendor/bundle/ruby/2.4.0/gems/faraday-0.14.0/lib/faraday/rack_builder.rb:143:in build_response' from /app/vendor/bundle/ruby/2.4.0/gems/faraday-0.14.0/lib/faraday/connection.rb:387:in run_request'
from /app/vendor/bundle/ruby/2.4.0/gems/faraday-0.14.0/lib/faraday/connection.rb:138:in get' from /app/vendor/bundle/ruby/2.4.0/gems/sawyer-0.8.1/lib/sawyer/agent.rb:94:in call'
from /app/vendor/bundle/ruby/2.4.0/gems/octokit-4.8.0/lib/octokit/connection.rb:156:in request' from /app/vendor/bundle/ruby/2.4.0/gems/octokit-4.8.0/lib/octokit/connection.rb:19:in get'
from /app/vendor/bundle/ruby/2.4.0/gems/octokit-4.8.0/lib/octokit/client/issues.rb:114:in issue' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-85c572552d68/lib/whedon/review.rb:21:in issue_body'
from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-85c572552d68/bin/whedon:71:in compile' 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-85c572552d68/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

'

sanskriti-s · 2019-07-11T21:25:15Z

@kyleniemeyer : Thank you so much for your revisions

whedon · 2019-07-11T21:25:19Z

Downloading of the repository (to check the bibtex) failed for issue #1420 failed with the following error:

/app/vendor/bundle/ruby/2.4.0/gems/octokit-4.8.0/lib/octokit/response/raise_error.rb:16:in on_complete': GET https://api.github.com/repos/openjournals/joss-reviews-testing/issues/1420: 404 - Not Found // See: https://developer.github.com/v3/issues/#get-a-single-issue (Octokit::NotFound) from /app/vendor/bundle/ruby/2.4.0/gems/faraday-0.14.0/lib/faraday/response.rb:9:in block in call'
from /app/vendor/bundle/ruby/2.4.0/gems/faraday-0.14.0/lib/faraday/response.rb:61:in on_complete' from /app/vendor/bundle/ruby/2.4.0/gems/faraday-0.14.0/lib/faraday/response.rb:8:in call'
from /app/vendor/bundle/ruby/2.4.0/gems/octokit-4.8.0/lib/octokit/middleware/follow_redirects.rb:73:in perform_with_redirection' from /app/vendor/bundle/ruby/2.4.0/gems/octokit-4.8.0/lib/octokit/middleware/follow_redirects.rb:61:in call'
from /app/vendor/bundle/ruby/2.4.0/gems/faraday-0.14.0/lib/faraday/rack_builder.rb:143:in build_response' from /app/vendor/bundle/ruby/2.4.0/gems/faraday-0.14.0/lib/faraday/connection.rb:387:in run_request'
from /app/vendor/bundle/ruby/2.4.0/gems/faraday-0.14.0/lib/faraday/connection.rb:138:in get' from /app/vendor/bundle/ruby/2.4.0/gems/sawyer-0.8.1/lib/sawyer/agent.rb:94:in call'
from /app/vendor/bundle/ruby/2.4.0/gems/octokit-4.8.0/lib/octokit/connection.rb:156:in request' from /app/vendor/bundle/ruby/2.4.0/gems/octokit-4.8.0/lib/octokit/connection.rb:19:in get'
from /app/vendor/bundle/ruby/2.4.0/gems/octokit-4.8.0/lib/octokit/client/issues.rb:114:in issue' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-85c572552d68/lib/whedon/review.rb:21:in issue_body'
from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-85c572552d68/lib/whedon.rb:291:in review_issue' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-85c572552d68/lib/whedon.rb:301:in download'
from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-85c572552d68/bin/whedon:38:in download' 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-85c572552d68/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

'

kyleniemeyer · 2019-07-11T21:57:07Z

@whedon accept

whedon · 2019-07-11T21:57:09Z

Attempting dry run of processing paper acceptance...

whedon · 2019-07-11T21:57:22Z


OK DOIs

- 10.1016/s0925-2312(00)00302-7 is OK
- 10.1109/sami.2015.7061899 is OK
- 10.21105/joss.00401 is OK
- 10.1016/j.fuel.2017.06.015 is OK

MISSING DOIs

- None

INVALID DOIs

- None

whedon · 2019-07-11T21:57:28Z

Check final proof 👉 openjournals/joss-papers#834

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

@whedon accept deposit=true

kyleniemeyer · 2019-07-11T22:15:28Z

@whedon accept deposit=true

whedon · 2019-07-11T22:15:31Z

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

whedon · 2019-07-11T22:16:07Z

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

whedon · 2019-07-11T22:16:08Z

🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨

Here's what you must now do:

Check final PDF and Crossref metadata that was deposited 👉 Creating pull request for 10.21105.joss.01420 joss-papers#835
Wait a couple of minutes to verify that the paper DOI resolves https://doi.org/10.21105/joss.01420
If everything looks good, then close this review issue.
Party like you just published a paper! 🎉🌈🦄💃👻🤘

Any issues? notify your editorial technical team...

kyleniemeyer · 2019-07-11T22:21:04Z

@sanskriti-s congrats on your submission's publication in JOSS! Thanks to @annoviko for reviewing and @arokem for editing!

whedon · 2019-07-11T22:21:07Z

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

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

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

This is how it will look in your documentation:

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:

Volunteering to review for us sometime in the future. You can add your name to the reviewer list here: http://joss.theoj.org/reviewer-signup.html
Making a small donation to support our running costs here: https://numfocus.salsalabs.org/donate-to-joss

whedon assigned arokem Apr 30, 2019

whedon added the review label Apr 30, 2019

whedon mentioned this issue Apr 30, 2019

[PRE REVIEW]: ECabc: A feature tuning program focused on Artificial Neural Network hyperparameters #1383

Closed

whedon assigned annoviko May 6, 2019

whedon added the accepted label Jul 11, 2019

kyleniemeyer closed this as completed Jul 11, 2019

whedon added published Papers published in JOSS recommend-accept Papers recommended for acceptance in JOSS. labels Mar 2, 2020

editorialbot mentioned this issue Dec 9, 2023

[PRE REVIEW]: fABBA: A Python library for the fast symbolic approximation of time series #6132

Closed

[REVIEW]: ECabc: A feature tuning program focused on Artificial Neural Network hyperparameters #1420

[REVIEW]: ECabc: A feature tuning program focused on Artificial Neural Network hyperparameters #1420

Comments

whedon commented Apr 30, 2019 • edited Loading

Status

Reviewer instructions & questions

Review checklist for @annoviko

Conflict of interest

Code of Conduct

General checks

Functionality

Documentation

Software paper

whedon commented Apr 30, 2019

whedon commented Apr 30, 2019

whedon commented Apr 30, 2019

annoviko commented May 6, 2019

whedon commented May 6, 2019

whedon commented May 6, 2019

annoviko commented May 6, 2019 • edited Loading

sanskriti-s commented May 15, 2019

arokem commented May 22, 2019

sanskriti-s commented May 23, 2019

arokem commented May 25, 2019

annoviko commented May 27, 2019

annoviko commented Jun 1, 2019

sanskriti-s commented Jun 3, 2019

annoviko commented Jun 4, 2019 • edited Loading

sanskriti-s commented Jun 5, 2019

annoviko commented Jun 10, 2019

arokem commented Jun 13, 2019

whedon commented Jun 13, 2019

arokem commented Jun 13, 2019

whedon commented Jun 13, 2019

whedon commented Jun 13, 2019

arokem commented Jun 13, 2019

sanskriti-s commented Jun 20, 2019

arokem commented Jun 24, 2019

whedon commented Jun 24, 2019

whedon commented Jul 11, 2019

kyleniemeyer commented Jul 11, 2019

kyleniemeyer commented Jul 11, 2019

whedon commented Jul 11, 2019

whedon commented Jul 11, 2019

kyleniemeyer commented Jul 11, 2019

kyleniemeyer commented Jul 11, 2019

whedon commented Jul 11, 2019

whedon commented Jul 11, 2019

kyleniemeyer commented Jul 11, 2019

kyleniemeyer commented Jul 11, 2019

whedon commented Jul 11, 2019

whedon commented Jul 11, 2019

sanskriti-s commented Jul 11, 2019

whedon commented Jul 11, 2019

kyleniemeyer commented Jul 11, 2019

whedon commented Jul 11, 2019

whedon commented Jul 11, 2019

whedon commented Jul 11, 2019

kyleniemeyer commented Jul 11, 2019

whedon commented Jul 11, 2019

whedon commented Jul 11, 2019

whedon commented Jul 11, 2019

kyleniemeyer commented Jul 11, 2019

whedon commented Jul 11, 2019

whedon commented Apr 30, 2019 •

edited

Loading

annoviko commented May 6, 2019 •

edited

Loading

annoviko commented Jun 4, 2019 •

edited

Loading