Skip to main content

Legal Entity Name Understanding

Project description

lenu - Legal Entity Name Understanding



in collaboration with



License Code style: black

lenu is a python library that helps to understand and work with Legal Entity Names in the context of the Legal Entity Identifier (LEI) Standard (ISO 17441) as well as the Entity Legal Form (ELF) Code List Standard (ISO 20275).

The library utilizes Machine Learning with scikit-learn and is distributed under Creative Commons Zero 1.0 Universal license.

The project was started in November 2021 as a collaboration of the Global Legal Entity Identifier Foundation (GLEIF) and Sociovestix Labs with the goal to explore how Machine Learning can support in detecting the legal form (ELF Code) from a legal name.

It provides:

  • an interface to download LEI and ELF Code data from GLEIF's public website
  • an interface to train and make use of Machine Learning models to classify ELF Codes from given Legal Names

Dependencies

lenu requires

  • python (>=3.8, <3.10)
  • scikit-learn - Provides the Machine Learning functionality
  • pandas - For reading and handling data
  • Typer - Adds the command line interface
  • requests and pydantic - For downloading LEI data from GLEIF's website

Installation

via PyPI:

pip install lenu

From github:

pip install https://github.com/Sociovestix/lenu

Editable install from locally cloned repository

git clone https://github.com/Sociovestix/lenu
pip install -e lenu

Usage

Create folders for LEI and ELF Code data and to store your models

mkdir data
mkdir models

Download LEI data and ELF Code data into your data folder

lenu download

Train a (default) ELF Code Classification model. An ELF Classification model is always Jurisdiction specific and will be trained from Legal Names from this Jurisdiction.

Examples:

lenu train DE       # Germany
lenu train US-DE    # United States - Delaware
lenu train IT       # Italy

Identify ELF Code by using a model. The tool will return the best scoring ELF Codes.

lenu elf DE "Hans Müller KG"
#   ELF Code                  Entity Legal Form name Local name     Score
# 0     8Z6G                              Kommanditgesellschaft  0.979568
# 1     V2YH                       Stiftung des privaten Rechts  0.001141
# 2     OL20  Einzelunternehmen, eingetragener Kaufmann, ein...  0.000714

Support and Contributing

Feel free to reach out to either Sociovestix Labs or GLEIF if you need support in using this library, in utilizing LEI data in general, or in case you would like to contribute to this library in any form.

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

lenu-0.1.1.tar.gz (104.8 kB view details)

Uploaded Source

Built Distribution

lenu-0.1.1-py3-none-any.whl (108.0 kB view details)

Uploaded Python 3

File details

Details for the file lenu-0.1.1.tar.gz.

File metadata

  • Download URL: lenu-0.1.1.tar.gz
  • Upload date:
  • Size: 104.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.9.13 Darwin/20.4.0

File hashes

Hashes for lenu-0.1.1.tar.gz
Algorithm Hash digest
SHA256 4ebca8640f0261c98c35ce9b2d17efc27dc0c121d2e46bf7961ba1cc72708420
MD5 fa116768322211e136ce5922b049b37c
BLAKE2b-256 d39526f66d8b5f1de150e058a6d06afaa1f52f838f06d11f679d1d663592a071

See more details on using hashes here.

File details

Details for the file lenu-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: lenu-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 108.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.9.13 Darwin/20.4.0

File hashes

Hashes for lenu-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cec94805b132504d0d30d7297a00fe03ac0a985046d418d7f197134e468a8f20
MD5 d7cfd3c7f87ced077650e4acae8985f4
BLAKE2b-256 5fa84925b99adaf32e82d09b398b7e03c70718f1c38faa2b34fd15d86b9d6fe6

See more details on using hashes here.

Supported by

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