Upload README.md with huggingface_hub

README.md

@@ -27,8 +27,10 @@ ESM
 - **Base Model:** bert-base-multilingual-uncased
 - **Intermediate Task:** cardiffnlp/tweet_sentiment_multilingual
 - **ESM architecture:** linear
+- **ESM embedding dimension:** [More Information Needed]
 - **Language(s) (NLP):** [More Information Needed]
 - **License:** Apache-2.0 license
+- **ESM version:** 0.1.0
 
 ## Training Details
 
@@ -74,14 +76,24 @@ MSE:
 ### Additional evaluation details [optional]
 
 
+## What are Embedding Space Maps used for?
+Embedding Space Maps are a part of ESM-LogME, a efficient method for finding intermediate datasets for transfer learning. There are two reasons to use ESM-LogME:
 
-## What are Embedding Space Maps?
+### You don't have enough training data for your problem
+If you don't have a enough training data for your problem, just use ESM-LogME to find more.
+You can supplement model training by including publicly available datasets in the training process. 
 
-<!-- This section describes the evaluation protocols and provides the results. -->
-Embedding Space Maps (ESMs) are neural networks that approximate the effect of fine-tuning a language model on a task. They can be used to quickly transform embeddings from a base model to approximate how a fine-tuned model would embed the the input text.
-ESMs can be used for intermediate task selection with the ESM-LogME workflow.
+1. Fine-tune a language model on suitable intermediate dataset.
+2. Fine-tune the resulting model on your target dataset.
 
-## How can I use Embedding Space Maps for Intermediate Task Selection?
+This workflow is called intermediate task transfer learning and it can significantly improve the target performance.
+
+But what is a suitable dataset for your problem? ESM-LogME enable you to quickly rank thousands of datasets on the Hugging Face Hub by how well they are exptected to transfer to your target task.
+
+### You want to find similar datasets to your target dataset
+Using ESM-LogME can be used like search engine on the Hugging Face Hub. You can find similar tasks to your target task without having to rely on heuristics. ESM-LogME estimates how language models fine-tuned on each intermediate task would benefinit your target task. This quantitative approach combines the effects of domain similarity and task similarity. 
+
+## How can I use ESM-LogME / ESMs?
 [![PyPI version](https://img.shields.io/pypi/v/hf-dataset-selector.svg)](https://pypi.org/project/hf-dataset-selector)
 
 We release **hf-dataset-selector**, a Python package for intermediate task selection using Embedding Space Maps.
@@ -111,27 +123,65 @@ task_ranking = compute_task_ranking(
 # Display top 5 recommendations
 print(task_ranking[:5])
 ```
+```python
+1.   davanstrien/test_imdb_embedd2                     Score: -0.618529
+2.   davanstrien/test_imdb_embedd                      Score: -0.618644
+3.   davanstrien/test1                                 Score: -0.619334
+4.   stanfordnlp/imdb                                  Score: -0.619454
+5.   stanfordnlp/sst                                   Score: -0.62995
+```
 
-For more information on how to use ESMs please have a look at the [official Github repository](https://github.com/davidschulte/hf-dataset-selector).
+|   Rank | Task ID                       | Task Subset     | Text Column   | Label Column   | Task Split   |   Num Examples | ESM Architecture   |     Score |
+|-------:|:------------------------------|:----------------|:--------------|:---------------|:-------------|---------------:|:-------------------|----------:|
+|      1 | davanstrien/test_imdb_embedd2 | default         | text          | label          | train        |          10000 | linear             | -0.618529 |
+|      2 | davanstrien/test_imdb_embedd  | default         | text          | label          | train        |          10000 | linear             | -0.618644 |
+|      3 | davanstrien/test1             | default         | text          | label          | train        |          10000 | linear             | -0.619334 |
+|      4 | stanfordnlp/imdb              | plain_text      | text          | label          | train        |          10000 | linear             | -0.619454 |
+|      5 | stanfordnlp/sst               | dictionary      | phrase        | label          | dictionary   |          10000 | linear             | -0.62995  |
+|      6 | stanfordnlp/sst               | default         | sentence      | label          | train        |           8544 | linear             | -0.63312  |
+|      7 | kuroneko5943/snap21           | CDs_and_Vinyl_5 | sentence      | label          | train        |           6974 | linear             | -0.634365 |
+|      8 | kuroneko5943/snap21           | Video_Games_5   | sentence      | label          | train        |           6997 | linear             | -0.638787 |
+|      9 | kuroneko5943/snap21           | Movies_and_TV_5 | sentence      | label          | train        |           6989 | linear             | -0.639068 |
+|     10 | fancyzhx/amazon_polarity      | amazon_polarity | content       | label          | train        |          10000 | linear             | -0.639718 |
+
+For more information on how to use ESMs please have a look at the [official Github repository](https://github.com/davidschulte/hf-dataset-selector). We provide documentation further documentation and tutorials for finding intermediate datasets and training your own ESMs.
+
+
+## How do Embedding Space Maps work?
+
+<!-- This section describes the evaluation protocols and provides the results. -->
+Embedding Space Maps (ESMs) are neural networks that approximate the effect of fine-tuning a language model on a task. They can be used to quickly transform embeddings from a base model to approximate how a fine-tuned model would embed the the input text.
+ESMs can be used for intermediate task selection with the ESM-LogME workflow.
+
+## How can I use Embedding Space Maps for Intermediate Task Selection?
 
 ## Citation
 
 
 <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-If you are using this Embedding Space Maps, please cite our [paper](https://arxiv.org/abs/2410.15148).
+If you are using this Embedding Space Maps, please cite our [paper](https://aclanthology.org/2024.emnlp-main.529/).
 
 **BibTeX:**
 
 
 ```
-@misc{schulte2024moreparameterefficientselectionintermediate,
-      title={Less is More: Parameter-Efficient Selection of Intermediate Tasks for Transfer Learning}, 
-      author={David Schulte and Felix Hamborg and Alan Akbik},
-      year={2024},
-      eprint={2410.15148},
-      archivePrefix={arXiv},
-      primaryClass={cs.CL},
-      url={https://arxiv.org/abs/2410.15148}, 
+@inproceedings{schulte-etal-2024-less,
+    title = "Less is More: Parameter-Efficient Selection of Intermediate Tasks for Transfer Learning",
+    author = "Schulte, David  and
+      Hamborg, Felix  and
+      Akbik, Alan",
+    editor = "Al-Onaizan, Yaser  and
+      Bansal, Mohit  and
+      Chen, Yun-Nung",
+    booktitle = "Proceedings of the 2024 Conference on Empirical Methods in Natural Language Processing",
+    month = nov,
+    year = "2024",
+    address = "Miami, Florida, USA",
+    publisher = "Association for Computational Linguistics",
+    url = "https://aclanthology.org/2024.emnlp-main.529/",
+    doi = "10.18653/v1/2024.emnlp-main.529",
+    pages = "9431--9442",
+    abstract = "Intermediate task transfer learning can greatly improve model performance. If, for example, one has little training data for emotion detection, first fine-tuning a language model on a sentiment classification dataset may improve performance strongly. But which task to choose for transfer learning? Prior methods producing useful task rankings are infeasible for large source pools, as they require forward passes through all source language models. We overcome this by introducing Embedding Space Maps (ESMs), light-weight neural networks that approximate the effect of fine-tuning a language model. We conduct the largest study on NLP task transferability and task selection with 12k source-target pairs. We find that applying ESMs on a prior method reduces execution time and disk space usage by factors of 10 and 278, respectively, while retaining high selection performance (avg. regret@5 score of 2.95)."
 }
 ```
 
@@ -139,7 +189,7 @@ If you are using this Embedding Space Maps, please cite our [paper](https://arxi
 **APA:**
 
 ```
-Schulte, D., Hamborg, F., & Akbik, A. (2024). Less is More: Parameter-Efficient Selection of Intermediate Tasks for Transfer Learning. arXiv preprint arXiv:2410.15148.
+Schulte, D., Hamborg, F., & Akbik, A. (2024, November). Less is More: Parameter-Efficient Selection of Intermediate Tasks for Transfer Learning. In Proceedings of the 2024 Conference on Empirical Methods in Natural Language Processing (pp. 9431-9442).
 ```
 
 ## Additional Information