Skip to content

Add audioset (WIP) #2331

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

Draft
wants to merge 1 commit into
base: maeb
Choose a base branch
from
Draft

Conversation

RahulSChand
Copy link

@RahulSChand RahulSChand commented Mar 11, 2025

Add audioset dataset part of #2319 . Also addressed #2049

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.

@RahulSChand RahulSChand added the maeb Audio extension label Mar 11, 2025
@RahulSChand RahulSChand self-assigned this Mar 11, 2025
@RahulSChand RahulSChand marked this pull request as draft March 11, 2025 19:13
@RahulSChand RahulSChand mentioned this pull request Mar 11, 2025
@RahulSChand RahulSChand changed the title Add audioset draft commit (WIP) Add audioset (WIP) Mar 11, 2025
Copy link
Contributor

@KennethEnevoldsen KennethEnevoldsen left a comment

Choose a reason for hiding this comment

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

Thanks for the PR. The description of task is missing.

Please remove irrelevant stuff (model checklist) from the message. I would also really like to see that a model has actually been run on the task to confirm that it works.

Comment on lines +38 to +40
descriptive_stats={
"n_samples": {"test": 8961}, # Need to change
},
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
descriptive_stats={
"n_samples": {"test": 8961}, # Need to change
},

Comment on lines +28 to +30
task_subtypes=[
"Environment Sound Classification"
], # Since this dataset has sounds of ALL types, this seems to be the best option
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
task_subtypes=[
"Environment Sound Classification"
], # Since this dataset has sounds of ALL types, this seems to be the best option
task_subtypes=[],

Hmm not sure about this one

class AudioSetMultilingualClassification(AbsTaskAudioMultilabelClassification):
metadata = TaskMetadata(
name="AudioSet",
description="Multilabel Audio Classification.",
Copy link
Contributor

Choose a reason for hiding this comment

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

Hard to know anything about the dataset from this

dataset={
"path": "agkphysics/AudioSet",
"revision": "5a2fa42a1506470d275a47ff8e1fdac5b364e6ef",
}, # this is actually used to download the data
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
}, # this is actually used to download the data
},

Comment on lines +23 to +26
date=(
"2020-01-01",
"2020-01-30",
), # Estimated date when this dataset was committed, what should be the second tuple?
Copy link
Contributor

Choose a reason for hiding this comment

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

This is the estimated time when the data was created (sounds produced, tweets posted, images taken). In between A and B.

"2020-01-01",
"2020-01-30",
), # Estimated date when this dataset was committed, what should be the second tuple?
domains=["Web"], # obtained from Freesound - online collaborative platform
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
domains=["Web"], # obtained from Freesound - online collaborative platform
domains=[],

I'm not sure about this one - it's hard to say with the description, though.

@RahulSChand
Copy link
Author

Thanks for the PR. The description of task is missing.

Please remove irrelevant stuff (model checklist) from the message. I would also really like to see that a model has actually been run on the task to confirm that it works.

Yeah, makes sense. Its currently a draft PR haven't run the actual model yet to get the numbers. Again this dataset is bigger than others so it will take some time

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

Successfully merging this pull request may close these issues.

2 participants