Skip to content

Adds VocalSound dataset #2337

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 7 commits into
base: maeb
Choose a base branch
from
Open

Adds VocalSound dataset #2337

wants to merge 7 commits into from

Conversation

mina-parham
Copy link
Contributor

@mina-parham mina-parham commented Mar 12, 2025

Closes #2313

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.

@mina-parham mina-parham added new dataset Issues related to adding a new task or dataset maeb Audio extension labels Mar 12, 2025
@mina-parham mina-parham requested a review from isaac-chung March 12, 2025 03:42
@mina-parham mina-parham self-assigned this Mar 12, 2025
Comment on lines 51 to 52
def dataset_transform(self):
self.dataset["train"] = self.dataset["test"]
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 it would be better to use cross-validation instead of test

Copy link
Member

Choose a reason for hiding this comment

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

Test split should be removed, because for now training and testing would be on same test split

Copy link
Collaborator

@isaac-chung isaac-chung left a comment

Choose a reason for hiding this comment

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

Nice! Just a few small comments.

@Samoed Samoed linked an issue Mar 26, 2025 that may be closed by this pull request
Copy link
Collaborator

@isaac-chung isaac-chung left a comment

Choose a reason for hiding this comment

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

Good progress so far.

  • Please remove all other changes related to dict.fromkeys in this PR. (Can be a sep PR to main)
  • Please run this dataset using one of the existing audio embedding models in the branch to confirm that your changes work

table_dict[lang] = {k: 0 for k in sorted(get_args(TASK_TYPE))}
table_dict[lang] = dict.fromkeys(sorted(get_args(TASK_TYPE)), 0)
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd prefer if these changes were reverted. Feel free to open a separate issue, and a PR to main

Copy link
Member

Choose a reason for hiding this comment

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

It seems that this file was formatted with different ruff version

month=may }
}""",
descriptive_stats={
"n_samples": {"validation": 1860, "test": 3594},
Copy link
Collaborator

Choose a reason for hiding this comment

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

To match eval_splits

Suggested change
"n_samples": {"validation": 1860, "test": 3594},
"n_samples": {"test": 3594},

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maeb Audio extension new dataset Issues related to adding a new task or dataset
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add VocalSound
3 participants