Skip to main content

A minimal implementation of KaRR knowledge assessment method for Large Language Models (LLMs)

Project description

Statistical Knowledge Assessment for Large Language Models

A minimal implementation of KaRR knowledge assessment method from the following paper:

Statistical Knowledge Assessment for Large Language Models,
Qingxiu Dong, Jingjing Xu, Lingpeng Kong, Zhifang Sui, Lei Li
arXiv preprint (arxiv_version)

This is a fork of the official implementation released by the authors.

How to use?

First, create a new virtual environment then install minkarr using the command:

pip install minkarr --extra-index-url https://download.pytorch.org/whl/cu121

Here is a simple example of how to quantify the knowledge of a fact by an LLM using KaRR

from karr import KaRR
from transformers import AutoModelForCausalLM, AutoTokenizer

model_name = 'gpt2'
device = 'cuda'
model = AutoModelForCausalLM.from_pretrained(model_name, device_map = device)
tokenizer = AutoTokenizer.from_pretrained(model_name)

karr = KaRR(model, tokenizer, device)

# Testing the fact: (France, capital, Paris)
# You can find other facts by looking into Wikidata
fact = ('Q142', 'P36', 'Q90')

karr, does_know = karr.compute(fact)
print('Fact %s' % str(fact))
print('KaRR = %s' % karr)
ans = 'Yes' if does_know else 'No'
print('According to KaRR, does the model knows this fact? Answer: %s' % ans)
# Output:
# KaRR = 3.338972442145268
# According to KaRR, does the model knows this fact? Answer: No

Difference with original repo

  • Easy-to-use
  • Cleaner code
  • Minimalistic implementation: I kept only the portion of the code needed to compute KaRR and removed the rest
  • This implementation can compute KaRR on a single fact (the original implementation went through all facts)

Citation

Cite the original authors using:

@misc{dong2023statistical,
      title={Statistical Knowledge Assessment for Large Language Models}, 
      author={Qingxiu Dong and Jingjing Xu and Lingpeng Kong and Zhifang Sui and Lei Li},
      year={2023},
      journal = {Proceedings of NeurIPS},
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

minkarr-0.1.3.tar.gz (11.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

minkarr-0.1.3-py3-none-any.whl (16.2 kB view details)

Uploaded Python 3

File details

Details for the file minkarr-0.1.3.tar.gz.

File metadata

  • Download URL: minkarr-0.1.3.tar.gz
  • Upload date:
  • Size: 11.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for minkarr-0.1.3.tar.gz
Algorithm Hash digest
SHA256 7a1c7cec401a78fac9d8ad66864099897e4703db50412f4eb6b3f3ca579d4323
MD5 18951e6de9da1256f1aabfd439461092
BLAKE2b-256 62a501000b25f8d4aac9a5d7c073e31d967aa5281350c82577ae9aa6c4338847

See more details on using hashes here.

File details

Details for the file minkarr-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: minkarr-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 16.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for minkarr-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 fb14b0ce1351e3f4622740170ab6176559b4e1ceff3cb91a113aac9f437ff9d5
MD5 d195b2186bd3b0bedb92c087f2cb08fa
BLAKE2b-256 3e0b94a8b3d0fb589cd05b63a5cca5e814f8e40348acc77a66792e094e02f24b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page