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.

Sign up for GitHub

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

Jump to bottom

write proper documentation #2

Open
martinghunt opened this issue Apr 1, 2020 · 3 comments
Open

write proper documentation #2

martinghunt opened this issue Apr 1, 2020 · 3 comments

Comments

@martinghunt
Copy link
Member

No description provided.

@mbhall88
Copy link
Member

mbhall88 commented Aug 10, 2020 •
edited
Loading

@martinghunt it would be helpful if you could document what the different sections in the output JSON file are? I have the JSON but don't really know what the differences between each section are.

For example, what is the difference between these three fields?

 "Recall": 0.8943507,
 "Recall_edit_dist": 0.89991875,
 "Recall_frac": 0.93283834,

@martinghunt
Copy link
Member Author

Yep, the documentation is on the to do list!

I just made this to answer that question. https://github.com/iqbal-lab-org/varifier/wiki/Summary-stats-JSON-file

@bricoletc
Copy link
Member

A minor point, but would be nice to link to that wiki page in the README.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@martinghunt @mbhall88 @bricoletc