Skip to content

add AbsTaskSpectralClustering #2430

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 19 commits into
base: main
Choose a base branch
from
Open

Conversation

OnAnd0n
Copy link
Contributor

@OnAnd0n OnAnd0n commented Mar 25, 2025

Code Quality

  • Code Formatted: Format the code using make lint to maintain consistent style.

Documentation

  • Updated Documentation: Add or update documentation to reflect the changes introduced in this PR.

Testing

  • New Tests Added: Write tests to cover new functionality. Validate with make test-with-coverage.
  • Tests Passed: Run tests locally using make test or make test-with-coverage to ensure no existing functionality is broken.

Adding datasets checklist

Reason for dataset addition: ...

  • I have run the following models on the task (adding the results to the pr). These can be run using the mteb -m {model_name} -t {task_name} command.
    • sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2
    • intfloat/multilingual-e5-small
  • I have checked that the performance is neither trivial (both models gain close to perfect scores) nor random (both models gain close to random scores).
  • If the dataset is too big (e.g. >2048 examples), considering using self.stratified_subsampling() under dataset_transform()
  • I have filled out the metadata object in the dataset file (find documentation on it here).
  • Run tests locally to make sure nothing is broken using make test.
  • Run the formatter to format the code using make lint.

@OnAnd0n
Copy link
Contributor Author

OnAnd0n commented Mar 25, 2025

@Samoed @KennethEnevoldsen

I have implemented Spectral Clustering to reflect cosine similarity, as we previously discussed.
question regarding clustering evaluation in MTEB
Initially, you suggested the following format:

class AbsTaskSpectralClustering(AbsTaskClusteringFast)
     clustering_model = sklearn.cluster.spectralclustering     
     ...

# and

class AbsTaskCosineClustering(AbsTaskClusteringFast)
     clustering_model = ...  
     ...

However, I noticed that the create_task_list() function collects task categories using a two-level iteration.
If a three-level structure(AbsTaskSpectralClustering -> AbsTaskClusteringFast -> AbsTask) is introduced,
tasks might not be properly collected into Task_list.

def create_task_list() -> list[type[AbsTask]]:
    tasks_categories_cls = list(AbsTask.__subclasses__())
    tasks = [
        cls
        for cat_cls in tasks_categories_cls
        for cls in cat_cls.__subclasses__()
        if cat_cls.__name__.startswith("AbsTask")
    ]
    return tasks

Could you review whether this approach is reasonable and applicable?
Thank you for your time.

logger = logging.getLogger(__name__)


class SpectralClusteringEvaluator(Evaluator):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be moved to evaluators

labels,
task_name: str | None = None,
clustering_batch_size: int = 500,
limit: int | None = None,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be removed in 2.0

Suggested change
limit: int | None = None,

Comment on lines +37 to +39
if limit is not None:
sentences = sentences[:limit]
labels = labels[:limit]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be removed in 2.0

Suggested change
if limit is not None:
sentences = sentences[:limit]
labels = labels[:limit]

return {"v_measure": v_measure}


class AbsTaskSpectralClustering(AbsTask):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you clustering is almost 1to1 to original clustering. Maybe it would be better to move evaluator to properties of task and your tasks will use

        for cluster_set in tqdm.tqdm(dataset, desc="Clustering"):
            evaluator = self.evaluator(
class Task(AbsClustering):
    evaluator = SpectralClusteringEvaluator

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Samoed
Thanks for your advice!

I will revise it again at 'evaluation' level (if it is deemed meaningful).
Additionally, I will apply try/except as well.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should build this on the fast clustering task, not AbsTaskClustering (it is much slower and gives less consistent estimates)

from collections import Counter
from typing import Any

import networkx as nx
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to convert with try... ecept I think this should be moved inside __call__

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants