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

type annotations #5

Open
seanmacavaney opened this issue Apr 18, 2021 · 1 comment
Open

type annotations #5

seanmacavaney opened this issue Apr 18, 2021 · 1 comment

Comments

@seanmacavaney
Copy link
Collaborator

add type annotations throughout
@janheinrichmerker
Copy link

Yep, that would indeed be great! In #43 I have added two very simple types for Qrels and Run:

ir_measures/ir_measures/util.py

Line 31 in 2708821

Qrels = Union[Iterable[Qrel], Dict[str, Dict[str, int]], DataFrame]

ir_measures/ir_measures/util.py

Line 40 in 2708821

Run = Union[Iterable[ScoredDoc], Dict[str, Dict[str, int]], DataFrame]

We could probably also include Iterable[NamedTuple] in the union so that it matches the documented behavior of QrelsConverter and RunConverter.

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
2 participants
@seanmacavaney @janheinrichmerker