Skip to content
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

Addition of : Thai, Romanian, Hebrew, Korean, Burmese, Nigerian (Multilingual) Datasets #724

Merged
merged 23 commits into from
May 16, 2024

Conversation

Art3mis0707
Copy link
Contributor

@Art3mis0707 Art3mis0707 commented May 15, 2024

Checklist for adding MMTEB dataset

Addition of :

  • Thai Restaurant Reviews Dataset - WongnaiReviewsClassification
  • Hebrew Sentiment Analysis Dataset - HebrewSentimentAnalysis
  • Korean Financial Sentiment Analysis Dataset - KorFin
  • Burmese News Classification Dataset - MyanmarNews
  • Romanian News Classification Dataset - Moroco
  • Nigerian (Multilingual) Twitter Sentiment Analysis Dataset - NaijaSenti

Reason for dataset addition:
All the datasets (except Korean) are low resource datasets, and were present mostly only in the multilingual datasets. Having monolingual datasets in low resource languages will enrich the diversity of the benchmark.

  • I have tested that the dataset runs with the mteb package.
  • I have run the following models on the task (adding the results to the pr). These can be run using the mteb run -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.
  • I have added points for my submission to the points folder using the PR number as the filename (e.g. 438.jsonl).

Copy link
Contributor

@imenelydiaker imenelydiaker 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 this addition! Below my comments.
Also please rename files with underscores by removing it (e.g., Thai_Restaurant_Reviews.json -> ThaiRestaurantReviews.json)

mteb/tasks/Classification/heb/Hebrew_Sentiment_Analysis.py Outdated Show resolved Hide resolved
mteb/tasks/Classification/heb/Hebrew_Sentiment_Analysis.py Outdated Show resolved Hide resolved
mteb/tasks/Classification/heb/Hebrew_Sentiment_Analysis.py Outdated Show resolved Hide resolved
mteb/tasks/Classification/heb/Hebrew_Sentiment_Analysis.py Outdated Show resolved Hide resolved
mteb/tasks/Classification/heb/Hebrew_Sentiment_Analysis.py Outdated Show resolved Hide resolved
mteb/tasks/Classification/tha/Thai_Restaurant_Reviews.py Outdated Show resolved Hide resolved
mteb/tasks/Classification/tha/Thai_Restaurant_Reviews.py Outdated Show resolved Hide resolved
mteb/tasks/Classification/tha/Thai_Restaurant_Reviews.py Outdated Show resolved Hide resolved
mteb/tasks/Classification/tha/Thai_Restaurant_Reviews.py Outdated Show resolved Hide resolved
mteb/tasks/Classification/tha/Thai_Restaurant_Reviews.py Outdated Show resolved Hide resolved
mteb/tasks/Classification/ron/Moroco.py Outdated Show resolved Hide resolved
mteb/tasks/Classification/ron/Moroco.py Outdated Show resolved Hide resolved
mteb/tasks/Classification/ron/Moroco.py Outdated Show resolved Hide resolved
mteb/tasks/Classification/tha/ThaiRestaurantReviews.py Outdated Show resolved Hide resolved
@KranthiGV
Copy link
Contributor

(In the interest of quick merging, I'd recommend not adding a new dataset after significant reviewing is done in the same PR.
Would be better to start a new PR)

@Art3mis0707
Copy link
Contributor Author

I've made all changes @KranthiGV @imenelydiaker
Please let me know if there's anything else I need to do
Thanks!

@Art3mis0707 Art3mis0707 changed the title Thai Restaurant Review Dataset Addition of : Thai, Romanian, Hebrew, Korean, Burmese, Nigerian (Multilingual) Datasets May 15, 2024
@Art3mis0707
Copy link
Contributor Author

Art3mis0707 commented May 15, 2024

I have also created a jsonl file and added points...2 for @imenelydiaker and @KranthiGV for reviewing and 12 for myself (6x2).

Copy link
Contributor

@imenelydiaker imenelydiaker left a comment

Choose a reason for hiding this comment

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

LGTM! Can you please add you name and affiliation here and run linting?

Art3mis0707 and others added 4 commits May 16, 2024 17:57
…ation.py

Co-authored-by: Imene Kerboua <33312980+imenelydiaker@users.noreply.github.com>
…ation.py

Co-authored-by: Imene Kerboua <33312980+imenelydiaker@users.noreply.github.com>
@Art3mis0707
Copy link
Contributor Author

LGTM! Can you please add you name and affiliation here and run linting?

I've done it.
Please check, thanks

Copy link
Contributor

@imenelydiaker imenelydiaker left a comment

Choose a reason for hiding this comment

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

LGTM, thank you for your contribution! Let's merge 🙂

@imenelydiaker imenelydiaker enabled auto-merge (squash) May 16, 2024 14:01
@imenelydiaker imenelydiaker merged commit 8f7817f into embeddings-benchmark:main May 16, 2024
7 checks passed
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.

None yet

3 participants