Skip to content

[v2] split query and conversation #2593

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 1 commit into
base: v2.0.0
Choose a base branch
from
Open

Conversation

Samoed
Copy link
Member

@Samoed Samoed commented Apr 29, 2025

Closes #1330

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.

Adding a model checklist

  • I have filled out the ModelMeta object to the extent possible
  • I have ensured that my model can be loaded using
    • mteb.get_model(model_name, revision) and
    • mteb.get_model_meta(model_name, revision)
  • I have tested the implementation works on a representative set of tasks.

@Samoed Samoed added the v2 Issues and PRs related to `v2` branch label Apr 29, 2025
@Samoed Samoed linked an issue Apr 29, 2025 that may be closed by this pull request
# list[list[str]] and list[Conversation] is used for conversations datasets
query: list[str] | list[list[str]] | list[Conversation]
query: list[str]
conversation: list[list[str | Conversation]]
Copy link
Contributor

Choose a reason for hiding this comment

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

I would do list[Conversation]. It seems like the current conversation is just one conversational turn (which I think is a bit misleading compared to what I suspect).

I am unsure when this would be list[list[str]]?

Copy link
Member Author

@Samoed Samoed May 2, 2025

Choose a reason for hiding this comment

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

Some dataset can have conversation like:

[
   [ 
      "hi! How are you?",  # speaker 1
      "Hi! Fine, thanks!",  # speaker 2
   ]
]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
v2 Issues and PRs related to `v2` branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add promptType Conversation
2 participants