Skip to content

Document unconditioned_query requirement for PMI normalization#1261

Open
nuthalapativarun wants to merge 1 commit into
huggingface:mainfrom
nuthalapativarun:docs/997-pmi-normalization-usage
Open

Document unconditioned_query requirement for PMI normalization#1261
nuthalapativarun wants to merge 1 commit into
huggingface:mainfrom
nuthalapativarun:docs/997-pmi-normalization-usage

Conversation

@nuthalapativarun

Copy link
Copy Markdown

`LogLikelihoodAccMetric(normalization=LogProbPMINorm())` raises `AssertionError: unconditioned_logprob must be provided for PMI normalization` unless the task's `prompt_function` sets `Doc.unconditioned_query`, but this requirement wasn't documented on `LogProbPMINorm` itself. This adds a docstring example (based on existing usage in `tasks/templates/multichoice.py` and the multilingual MMLU tasks) showing how to set `unconditioned_query` so PMI normalization works.

Closes #997

@nuthalapativarun

Copy link
Copy Markdown
Author

Bumping this for visibility whenever a maintainer has some free time. Appreciate you taking a look, no pressure on timing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] PMI normalization unusable: requires unconditioned_logprob but API/docs don’t expose a way to provide it

1 participant