BlueBrain / BlueBrain/atlas-annotation

Explain metrics from `experiments/eval.py` in `README.md`

Open Beginner friendly
#31 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
6
Forks
1
PR merge metrics
No merged PRs in 30d

Description

It could be nice to have in the `README.md` a section explaining the `eval.py` file and the different evaluation metrics.

Contributor guide

Open the contributing guide

Research direction

Start by reading experiments/eval.py to identify the evaluation metrics and then inspect README.md for the appropriate section and existing terminology. Document what eval.py does and explain each metric in README.md; the work is complete when a reader can understand the file and its metrics from the README alone.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.