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 Pytorch-CUDA, and finally install minkarr using the command:

pip install minkarr

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

from minkarr import KaRR
from transformers import AutoModelForCausalLM, AutoTokenizer

model_name = "gpt2"
device = "cuda"
model = AutoModelForCausalLM.from_pretrained(model_name).cuda()
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.5.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.5-py3-none-any.whl (16.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: minkarr-0.1.5.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.5.tar.gz
Algorithm Hash digest
SHA256 885ff15a7fd9da4c3947d2fa0dd0bff283a9cb714610c059c7dc1fc0eebe5ec6
MD5 65535504f1321df07334256d590f96e5
BLAKE2b-256 0bb22168535d22608a0533dca10b227eb8f9eeae4ddd8538543b78449b1baea8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: minkarr-0.1.5-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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 65cbe7fef706a02f247ce4db8a3521ba1c7fbca80aeb873ff47849480d54bf7e
MD5 0cb4d4bc551dc76c916e725a573471ea
BLAKE2b-256 7b6eeccbf953fff4fd8a3d30c592f67106312d5b5d054ea7086680b1875b58c2

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