NTMC-Community / MatchZoo

Facilitating the design, comparison and sharing of deep text matching models.
Apache License 2.0
3.83k stars 899 forks source link

Recall metric implementation #720

Closed vmanisha closed 5 years ago

vmanisha commented 5 years ago

Is your feature request related to a problem? Please describe.

Recall metrics are required for certain type of experiments.

Describe the solution you'd like

I was hoping to submit my small implementation as a pull request. What is the best branch to do that? Or should i create a new branch entirely. This will be my first pull request, so I would like as much critical feedback as possible.

uduse commented 5 years ago

@vmanisha I agree that recall is a commonly used metric and will be a nice addition to matchzoo. Also, the change you're proposing is rather independent: you only need to add one file under matchzoo/metrics and one test under tests/unit_test/test_metrics.py so it's a nice feature to PR for beginners.

We have a general contribution guide here for contributors and you should read that thoroughly. The process might be overwhelming at first since this is your first PR, but no worries, we will help you along the way. You are welcomed to add additional questions in this issue, or chat with us on gitter.

In terms of your specific question:

What is the best branch to do that?

Your own branch named feature/add-recall-metric or something.

smenon8 commented 4 years ago

Would love to take a stab at this..