Joss-reviews: [REVIEW]: Yellowbrick: Visualizing the Scikit-Learn Model Selection Process

Created on 11 Nov 2018  Â·  41Comments  Â·  Source: openjournals/joss-reviews

Submitting author: @bbengfort (Benjamin Bengfort)
Repository: https://github.com/DistrictDataLabs/yellowbrick
Version: v0.8
Editor: @arfon
Reviewer: @mnarayan
Archive: 10.5281/zenodo.1206239

Status

status

Status badge code:

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

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

@mnarayan, 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 @arfon know.

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

Review checklist for @mnarayan

Conflict of interest

Code of Conduct

General checks

  • [x] Repository: Is the source code for this software available at the repository url?
  • [x] License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • [x] Version: Does the release version given match the GitHub release (v0.8)?
  • [x] Authorship: Has the submitting author (@bbengfort) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

Functionality

  • [x] Installation: Does installation proceed as outlined in the documentation?
  • [x] Functionality: Have the functional claims of the software been confirmed?
  • [x] 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

  • [x] A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • [x] Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
  • [x] Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
  • [x] Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • [x] Automated tests: Are there automated tests or manual steps described so that the function of the software can be verified?
  • [x] 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?
  • [x] A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • [x] References: Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?
accepted published recommend-accept review

Most helpful comment

I've just emailed @mnarayan to ask them to complete their review in the next week or two.

All 41 comments

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

:star: Important :star:

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
Attempting PDF compilation. Reticulating splines etc...

@mnarayan - please carry out your review in this issue by updating the checklist above and giving feedback in this issue. The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html

Any questions/concerns please let me know!

:wave: @mnarayan - please try and get to this review soon.

_bump_ please review this submission soon.

:wave: @mnarayan - it looks like you're part-way through your review. Do you think you might be able to complete it in the next week?

:wave: @mnarayan - please leave an update on this review issue when you can.

I've just emailed @mnarayan to ask them to complete their review in the next week or two.

Sorry for the delay, will finish my comments this week.

:wave: @mnarayan - did you manage to complete your review?

:wave: @mnarayan - please update us on your progress when you get a chance.

I am finished with my review. I can't find anything more that needs to be done for publication. This package is beautiful.

I am finished with my review. I can't find anything more that needs to be done for publication. This package is beautiful.

Great, thanks @mnarayan.

@bbengfort - At this point could you make an archive of the reviewed software in Zenodo/figshare/other service and update this thread with the DOI of the archive? I can then move forward with accepting the submission.

@whedon generate pdf

Attempting PDF compilation. Reticulating splines etc...

One quick question @bbengfort - I notice there are a lot of contributors to this package, and your paper mentions a number of core contributors yet I only see two of you listed as authors on the JOSS paper. Is this correct?

@mnarayan thank you so much for the review and the compliment!

@arfon we're really excited about this publication! The DOI of the official Yellowbrick archive (with all versions) is 10.5281/zenodo.1488364. As for your question about the authors - @rebeccabilbro and I are the primary authors of Yellowbrick and the maintainers. After discussing with our other core contributors we feel that the easiest and most equitable thing for everyone is if it's just the two of us listed as authors on the paper and our core contributors are mentioned in the acknowledgements. We are proud of the number of contributors we've had to the package, and on every release we list everyone who contributed as recognition.

Thanks again for all your hard work on JOSS!

Thank you so much @mnarayan for your review — we are excited to get the word out about visual diagnostics for model selection via JOSS!! Sincere thanks also to @arfon for shepherding our paper through the process; we are deeply grateful to you both for volunteering your time and energies to this important work!

@whedon set 10.5281/zenodo.1488364 as archive

OK. 10.5281/zenodo.1488364 is the archive.

@whedon accept

Attempting dry run of processing paper acceptance...

@whedon accept

Attempting dry run of processing paper acceptance...

```Reference check summary:

OK DOIs

  • 10.5281/zenodo.1206239 is OK
  • 10.1109/MCSE.2007.55 is OK
  • 10.1016/j.visinf.2017.01.006 is OK
  • 10.1002/sam.11271 is OK

MISSING DOIs

INVALID DOIs

  • None
    ```

@bbengfort @rebeccabilbro - could you see if that DOI suggested by Whedon is the correct one for your references? If so, please add it to the bibtex.

```Reference check summary:

OK DOIs

  • 10.5281/zenodo.1206239 is OK
  • 10.1109/MCSE.2007.55 is OK
  • 10.1016/j.visinf.2017.01.006 is OK
  • 10.1002/sam.11271 is OK

MISSING DOIs

INVALID DOIs

  • None
    ```

@arfon could we update our archive DOI to 10.5281/zenodo.1206239 please? This will resolve to the latest version of Yellowbrick, whereas the DOI I supplied before will only resolve to v0.9.

The DOI for the Interactive Optimization paper is correct, I'm updating the bibtex now!

@arfon the bibtex has been updated in the Yellowbrick repo.

@whedon set 10.5281/zenodo.1206239 as archive

OK. 10.5281/zenodo.1206239 is the archive.

@whedon check references

Attempting to check references...

```Reference check summary:

OK DOIs

  • 10.5281/zenodo.1206239 is OK
  • 10.1109/MCSE.2007.55 is OK
  • 10.1145/2935694.2935698 is OK
  • 10.1016/j.visinf.2017.01.006 is OK
  • 10.1002/sam.11271 is OK
  • 10.1145/1753326.1753529 is OK

MISSING DOIs

  • None

INVALID DOIs

  • None
    ```

@whedon generate pdf

Attempting PDF compilation. Reticulating splines etc...

@mnarayan - many thanks for your review here ✨

@bbengfort @rebeccabilbro - your paper is now accepted into JOSS :zap::rocket::boom:

:tada::tada::tada: Congratulations on your paper acceptance! :tada::tada::tada:

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

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

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

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:

Was this page helpful?
0 / 5 - 0 ratings