scikit-learn / scikit-learn/scikit-learn

Consensus Index for Clustering Model Selection

Open
#11,778 7 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Documentation help wanted module:cluster
Dominant language
Python
Stars
67.3k
Forks
27.4k
Avg merge
1d 15h
Merged PRs (30d)
58

Description

The sentence:

XXX can also be useful in a purely unsupervised setting as a
  building block for a Consensus Index that can be used for clustering
  model selection (TODO).

is in the description of every clustering metric that requires a ground truth label. Is there a write-up somewhere of an example workflow to build such a Consensus Index using these metrics? I searched through old issues and the original PRs creating this documentation and I can't see anything that looks like that. Though to be fair, I'm a big dummy, so I could just be missing it. If there isn't, is this TODO still really a TODO and is there an existing issue for it that I'm also too dumb to find? Thanks!

❤️

cc @ogrisel since you seem to be the og implementor and the original author of these docs.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the clustering metric descriptions, the old issues, and the original PRs mentioned in the report. Determine whether the Consensus Index TODO still represents missing documentation and identify a concrete example workflow to document. Done means the existing reference is either replaced with a useful write-up or the outdated TODO is removed, with the decision explained.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, machine-learning
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.