entity-resolution-evaluation
A python package to evaluate entity resolution
This package allows to evaluate entity resolution by efficiently computing several state of the art metrics : basic merge distance, precision, recall, variation of information. It's using the slice algorithm from the paper :
Menestrina, David and Whang, Steven Euijong and Garcia-Molina, Hector (2010) Evaluating Entity Resolution Results http://ilpubs.stanford.edu:8090/975/3/ERMetricVLDB.pdf
Getting Started
Installing
pip install entity-resolution-evaluation
Testing
Evaluate your resolution R against the gold standard S using a metric.
Examples
S = [[0, 1], [2, 3, 4], [5]]
R = [[0, 1, 2], [3, 4], [5]]
evaluate(R,S, 'bmd')
# returns 2
To go from R to S, you have to do 1 split and 1 merge.
evaluate(R,S,'precision')
# returns 0.5,
Half of the pairs of R are incorrect. (0,2) and (1,2) are incorrect. (0,1) and (3,4) are correct
evaluate(R,S,'recall')
# returns 0.5
Half of the pairs of S are present in R. (0,1) and (3,4) are present. (2,3) and (2,4) are absent.
evaluate(R,S,'variation of information')
# returns 0.6365141682948129
Metrics
You can currently compute the following metrics :
| metric | value if perfect | bounds | intepretation |
|---|---|---|---|
| 'bmd' | 0 | [0,infinity] | basic merge distance : the number of split and merge necessary to go from R to S |
| 'precision' | 1 | [0,1] | proportion of pairs in R present in S |
| 'recall' | 1 | [0,1] | proportion of pairs in S present in R |
| 'f1' | 1 | [0,1] | harmonic mean of precision and recall |
| 'variation_of_information' | 0 | [0,infinity] | amount of information that is lost and added to go from R to S |
Credits
Please visit the Hopkins mission page for more information
License
MIT License
Copyright (c) 2018 Ministère de l'Action et des Comptes Publics, Paul Boosz, Benoît Guigal
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Metadata
Release files for entity-resolution-evaluation 0.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| entity_resolution_evaluation-0.0.2.tar.gz | 6.0 kB | Without provenance | Details for entity_resolution_evaluation-0.0.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| entity_resolution_evaluation-0.0.2-py3-none-any.whl | Python 3 | none | any | Details for entity_resolution_evaluation-0.0.2-py3-none-any.whl |
Total release size: 14.0 kB
Release files / entity_resolution_evaluation-0.0.2.tar.gz
| Download URL | entity_resolution_evaluation-0.0.2.tar.gz |
|---|---|
| Size | 6.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
77609c039f46e6d56175f9e7e078b266cb8d7abe56ed0a061166a17f1863a22b
|
|
BLAKE2b-256 checksum How to use checksums |
caf0651ef32b8a6ae6fa1398330d7584cb4d2e8aff15bf55d0f6235d1e3deec4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.4.2 requests/2.18.4 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.27.0 CPython/3.6.5
|
Release files / entity_resolution_evaluation-0.0.2-py3-none-any.whl
| Download URL | entity_resolution_evaluation-0.0.2-py3-none-any.whl |
|---|---|
| Size | 8.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
75a91187fc873d7d041a45679beaf429d56ff09d07e7d0b1b3c99e023d6df17b
|
|
BLAKE2b-256 checksum How to use checksums |
4cce01297dcfa2e1b941994535a6e0b7544c448b4e35af6c0e8dfe824c6e7422
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.4.2 requests/2.18.4 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.27.0 CPython/3.6.5
|
Security for entity-resolution-evaluation 0.0.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.