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

readme(/JOSS): add high-level summary #137

Closed
egpbos opened this issue Jan 24, 2022 · 0 comments · Fixed by #178
Closed

readme(/JOSS): add high-level summary #137

egpbos opened this issue Jan 24, 2022 · 0 comments · Fixed by #178
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@egpbos
Copy link
Member

egpbos commented Jan 24, 2022

For JOSS we need: "A summary describing the high-level functionality and purpose of the software for a diverse, non-specialist audience."

Related, the GT suggested these general comments for the readme which may be relevant:

The README intro reads too much like a paper intro. It should be shorter and more to the point, then extended with the current information. It is not clear from the README explanation who is target user of the package, and what software stack it supports. In the first paragraph, it could have this information. For instance, “DIANNA provides insight tools for Deep Learning frameworks in order to increase the explainability of these models. It supports PyTorch and Tensorflow in addition to blah.”

Furthermore, you need to be more explicit about “non-specialist researcher user”. What experience does the user need to use DIANNA? For example experience with PyTorch/Tensorflow, ONNX and familiarity with Explainable AI? You should define the target user profile.

Anything that is “new” to the user could be reinforced. This could also help promote the DIANNA docs as the first contact about some of these topics, e.g. “Have you heard about XAI? See how to make your Deep Learning model explainable here.”

@egpbos egpbos added the documentation Improvements or additions to documentation label Jan 24, 2022
@egpbos egpbos self-assigned this Jan 31, 2022
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

Successfully merging a pull request may close this issue.

1 participant