capreolus-ir / capreolus

A toolkit for end-to-end neural ad hoc retrieval
https://capreolus.ai
Apache License 2.0
95 stars 32 forks source link

Type safety #131

Closed janheinrichmerker closed 2 years ago

janheinrichmerker commented 3 years ago

Thanks for this well-written framework! I'm currently discovering the aspects of the Capreolus framework and plan to write a custom Reranker. Though, I find that a bit difficult, as IDE support is limited. How do you think about the idea of making as much of the Capreolus code-base type safe? For example, when a method uses Qrels, why don't we specify the dict structure as well?

andrewyates commented 3 years ago

I think adding type annotations is a good idea. This is something we considered but haven't prioritized, so any contributions adding them would be welcome. Just let us know if you run into any questions when implementing your Reranker!

janheinrichmerker commented 2 years ago

Closing due to inactivity.