Skip to main content

Compute rankings in Python.

Project description

Ranky

Compute rankings in Python.

Build Status

logo

Get started

pip install ranky
import ranky as rk

Read the documentation.

Main functions

The main functionalities include scoring metrics (e.g. accuracy, roc auc), rank metrics (e.g. Kendall Tau, Spearman correlation), ranking systems (e.g. Majority judgement, Kemeny-Young method) and some measurements (e.g. Kendall's W coefficient of concordance).

Most functions takes as input 2-dimensional numpy.array or pandas.DataFrame objects. DataFrame are the best to keep track of the names of each data point.

Let's consider the following preference matrix:

matrix

Each row is a candidate and each column is a judge. Here is the results of rk.borda(matrix), computing the mean rank of each candidate:

borda

We can see that candidate2 has the best average ranking among the four judges.

Let's display it using rk.show(rk.borda(matrix)):

display

Ranking systems

Rank aggregation methods available:

  • Random Dictator: rk.dictator(m)
  • Score Voting: rk.score(m)
  • Borda Count: rk.borda(m)
  • Majority Judgement: rk.majority(m)
  • Condorcet, p-value Condorcet: rk.condorcet(m), rk.condorcet(m, wins=rk.p_wins)
  • Optimal rank aggregation using any rank metric: rk.center(m), rk.center(m, method='kendalltau'). Solver used [1].
  • (Kemeny-Young method is optimal rank aggregation using Kemeny distance as metric.)
  • (Optimal rank aggregation using Spearman correlation as metric is equivalent to Borda count.)

Metrics

Use any_metric(a, b, method) to call a metric from any of the three categories below.

  • Scoring metrics: rk.metric(y_true, y_pred, method='accuracy'). Methods include: ['accuracy', 'balanced_accuracy', 'precision', 'average_precision', 'brier', 'f1_score', 'mxe', 'recall', 'jaccard', 'roc_auc', 'mse', 'rmse', 'sar']

  • Rank correlation coefficients: rk.corr(r1, r2, method='spearman'). Methods include: ['kendalltau', 'spearman', 'pearson']

  • Rank distances: rk.dist(r1, r2, method='levenshtein'). Methods include: ['hamming', 'levenshtein', 'winner', 'euclidean']

To add: general edit distances, kemeny distance, regression metrics...

Visualizations

  • Use rk.show to visualize preference matrix (2D) or ranking ballots (1D).

>>> rk.show(m)

show example 1

>>> rk.show(m['judge1'])

show example 2

  • Use rk.mds, to visualize (in 2D or 3D) the points in a given metric space.

>>> rk.mds(m, method='euclidean')

MDS example 1

>>> rk.mds(m, method='spearman', axis=1)

MSE example 2

  • You can use rk.tsne similarly to rk.mds.

Other

  • Rank, rk.rank, convert a 1D score ballot to ranking.
  • Bootstrap, rk.bootstrap, sample a given axis.
  • Consensus, rk.consensus, check if ranking exactly agree.
  • Concordance, ,rk.concordance, mean rank distance between all judges of a preference matrix.
  • Centrality, rk.centrality, mean rank distance between a ranking and a preference matrix.
  • Kendall's W, rk.kendall_w, coefficient of concordance.

[1] Storn R. and Price K., Differential Evolution - a Simple and Efficient Heuristic for Global Optimization over Continuous Spaces, Journal of Global Optimization, 1997, 11, 341 - 359.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

ranky-0.0.4-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

File details

Details for the file ranky-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: ranky-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 15.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.6

File hashes

Hashes for ranky-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 2f940c67ce00a5beb6450254e618ed287047fd78c30198042bbb912f49243471
MD5 f4bdd19296be4a12c9859382780ee0e2
BLAKE2b-256 fc7b2eeb3540ee1dbd2c0aef3e4da8cacd6ae30206a6291e5ede7baa5ad349fe

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