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

Improve on Readme #3

Open
CDieterich opened this issue Mar 23, 2023 · 0 comments
Open

Improve on Readme #3

CDieterich opened this issue Mar 23, 2023 · 0 comments
Assignees

Comments

@CDieterich
Copy link

Hi @AminaLEM

please try to imagine that you are a first time user.. the first thing I would like to know is what this readme is about.

What is the purpose, what is the input, what steps are taken and what will be the output.

Please explain right in the beginning.

Users might also be interested in typical use cases.. the term predict for example IMHO does not involve retraining, but refers to the application of an existing model.. However, this does not seem to be the case.

One purpose is to reproduce the results of the paper end-to-end..

Another keyword is generalization.. how would a user move on to use different data and reapply existing models.

Please proceed along these lines.

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

No branches or pull requests

2 participants