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

[JOSS] comments on the paper #24

Open
kmichael08 opened this issue Jan 15, 2022 · 0 comments
Open

[JOSS] comments on the paper #24

kmichael08 opened this issue Jan 15, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@kmichael08
Copy link

kmichael08 commented Jan 15, 2022

My comments on the software paper wrt to the JOSS submission:

  • In the abstract, you declare two useful tools and then say: "For instance, one of these tools provides (...)". Since there are only two tools, I'd also suggest describing the other one as well. Additionally, instead of "for instance", I'd go with one sentence per each tool. This way, I can only guess what the other functionality is.
  • The last sentence in the abstract is quite long, and I would consider breaking it into shorter pieces.
  • My understanding is that your input is the implementation of the SS3 algorithm. Therefore, I'd be happy to see a bit more details about the algorithm to make the paper self-contained. Also, the title gives the impression of you introducing a new model/algorithm. I believe the input of this work is an implementation? This distinction is not very clear to me. Also, does it mean the SS3 algorithm was proposed without any implementation? That sounds a bit confusing.
  • Is the explanation tool model-specific, or it works with any classification method? What is your exact input here (the explanation algorithm or GUI?). If it's a model-agnostic explanation, perhaps it could be implemented in a different package?
  • github -> GitHub?
  • since explanations of the models are not the primary contribution of this work (?), you could consider adding a reference to some work in this area.
  • Line 40: "On the other hand" doesn't contrast with anything, and definitely no "On the one hand". Maybe you could consider rephrasing this
  • Footnote 2 has an issue with spacing – no space between "ArXiv" and a bracket

I ticked all the boxes for this part anyways. An exciting paper overall. I like the examples particularly. However, it's not clear what the exact contributions are: model implementation and the explanation GUI (or algorithm)?

In reference to openjournals/joss-reviews#3934

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

No branches or pull requests

2 participants