Skip to main content

A library for lightweight entity linking

Project description

Lightweight entity linking solution.

Please consider citing our works if you use code from this repository.\n We recommend using a Colab T4 GPU for faster results.

Main dependencies

  • python>=3.10
  • numpy==1.26.4
  • SPARQLWrapper==2.0.0
  • sentence_transformers==3.1.1
  • aiohttp==3.9.5
  • openai==1.54.2
  • beautifulsoup4==4.12.2
  • fake-useragent==1.5.1
  • nest_asyncio==1.5.8

Example & Usage

from linking import main

# Your API token which can be found here (https://github.com/marketplace/models/azure-openai/gpt-4o)
api_token = "YOUR_API_TOKEN"

main.EL(api_token=api_token, sentence="We used PCA and FA for our experiments.", mention="PCA and FA", single="No", combination="No", disambiguation="Yes", embedding_model="Lajavaness/bilingual-embedding-large")
The correct entity for 'PCA' is:

Wikipedia: https://en.wikipedia.org/wiki/Principal_component_analysis

Wikidata: https://www.wikidata.org/wiki/Q2873

DBpedia: http://dbpedia.org/resource/Principal_component_analysis



The correct entity for 'FA' is:

Wikipedia: https://en.wikipedia.org/wiki/Factor_analysis

Wikidata: https://www.wikidata.org/wiki/Q726474

DBpedia: http://dbpedia.org/resource/Factor_analysis

Execution Time: 00:00:35

Parameters

  • api_token: Your API token from here. (Required)
  • sentence: An english text. (Required)
  • mention: The mention you want to perform the linking, the mention should be from inside the provided sentence. (Required)
  • disambiguation: Used when the mention has acronyms or the mention has two different entities inside (e.g. PCA and FA), (deafult="Yes"), (Values: "Yes", "No"). (Optional)
  • single: Usually used for difficult mentions, it searches each word of the mention individually, (deafult="No"), (Values: "Yes", "No"). (Optional)
  • combination: Usually used for difficult mentions, it makes combinations for each word of the mention, (deafult="No"), (Values: "Yes", "No"). (Optional)
  • embedding_model: A sentence-transformers model to perform text similarity, (deafault="Lajavaness/bilingual-embedding-large"), (Values: str of the name of any sentence-transformers model). (Optional)

Licence

This library is licensed under the CC-BY-NC 4.0 license.

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

py_entity_linking-0.0.6.tar.gz (7.7 kB view details)

Uploaded Source

Built Distribution

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

py_entity_linking-0.0.6-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file py_entity_linking-0.0.6.tar.gz.

File metadata

  • Download URL: py_entity_linking-0.0.6.tar.gz
  • Upload date:
  • Size: 7.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.1

File hashes

Hashes for py_entity_linking-0.0.6.tar.gz
Algorithm Hash digest
SHA256 8e11aa6812a4bcd9107b4e05e03080b758c827ed5b79d4664dab2644024f9348
MD5 97156a172aab3ee3681717da5f6ebc76
BLAKE2b-256 9cfa2ca630c8f84456c076e019598bf994c518c8c2cb31bdde08ba8238019fc8

See more details on using hashes here.

File details

Details for the file py_entity_linking-0.0.6-py3-none-any.whl.

File metadata

File hashes

Hashes for py_entity_linking-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 c9b4d5c7ba23be70e4c0e68ef3ba97d8afb539aade3e0fa7d9746e624c8afbe2
MD5 aa0b59463dbd6e122cad0ba76d6b84f5
BLAKE2b-256 33d7cadb10a24ea68386c6e86ac5b9cee2036261f8af681eb287b7c1fa968ae5

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