ER-Evaluation 2.3.0

Installation

Install the released version from PyPI using:

pip install er-evaluation

Or install the development version using: .. code:: bash

pip install git+https://github.com/Valires/er-evaluation.git

Documentation

Please refer to the documentation website er-evaluation.readthedocs.io.

Usage Examples

Please refer to the User Guide or our Visualization Examples for a complete usage guide.

In summary, here’s how you might use the package.

1. Import your predicted disambiguations and reference benchmark dataset. The benchmark dataset should contain a sample of disambiguated entities.

import er_evaluation as ee

predictions, reference = ee.load_pv_disambiguations()

2. Plot summary statistics and compare disambiguations.

ee.plot_summaries(predictions)

ee.plot_comparison(predictions)

3. Define sampling weights and estimate performance metrics.

ee.plot_estimates(predictions, {"sample":reference, "weights":"cluster_size"})

4. Perform error analysis using cluster-level explanatory features and cluster error metrics.

ee.make_dt_regressor_plot(
        y,
        weights,
        features_df,
        numerical_features,
        categorical_features,
        max_depth=3,
        type="sunburst"
)

Development Philosophy

ER-Evaluation is designed to be a unified source of evaluation tools for entity resolution systems, adhering to the Unix philosophy of simplicity, modularity, and composability. The package contains Python functions that take standard data structures such as pandas Series and DataFrames as input, making it easy to integrate into existing workflows. By importing the necessary functions and calling them on your data, you can easily use ER-Evaluation to evaluate your entity resolution system without worrying about custom data structures or complex architectures.

Citation

Please acknowledge the publications below if you use ER-Evaluation:

• Binette, Olivier. (2022). ER-Evaluation: An End-to-End Evaluation Framework for Entity Resolution Systems. Available online at github.com/Valires/ER-Evaluation

• Binette, Olivier, Sokhna A York, Emma Hickerson, Youngsoo Baek, Sarvo Madhavan, Christina Jones. (2022). Estimating the Performance of Entity Resolution Algorithms: Lessons Learned Through PatentsView.org. arXiv e-prints: arxiv:2210.01230

• Upcoming: “An End-to-End Framework for the Evaluation of Entity Resolution Systems With Application to Inventor Name Disambiguation”

Public License

• GNU Affero General Public License v3

2.3.0 (November 29, 2023)

• Fix handling of NaN values in compress_memberships()

2.2.1 (November 8, 2023)

• Small fixes to paper and documentation.

2.2.0 (October 26, 2023)

• Streamline package structure

• Additional tests

• Improved documentation

2.1.0 (June 02, 2023)

• Add sunburst visualization for decision tree regressors

• Add decision tree regression pipeline for subgroup discovery

• Add search utilities

• Prepare submission to JOSS

2.0.0 (March 27, 2023)

• Improve documentation

• Add handling of NA values

• Bug fixes

• Add datasets module

• Add visualization functions

• Performance improvements

• BREAKING: error_analysis functions have been renamed.

• BREAKING: estimators have been renamed.

• Added estimators support for sensitivity analyses

• Added fairness plots

• Performance improvements

• Added compress_memberships() function for performance improvements.

1.2.0 (January 11, 2022)

• Refactoring and documentation overhaul.

1.1.0 (January 10, 2022)

• Added additional error metrics, performance evaluation metrics, and performance estimators.

• Added record-level error metrics and error analysis tools.

1.0.2 (December 5, 2022)

• Update setup.py with find_packages()

1.0.1 (November 30, 2022)

• Add “normalize” option to plot_cluster_sizes_distribution.

• Fix bugs in homonimy_rate and and name_variation_rate.

• Fix bug in estimators.

1.0.0

• Initial release