raphaelsty's picture
Update README.md
193e6b8 verified
metadata
language:
  - en
multilinguality:
  - monolingual
size_categories:
  - <1K
task_categories:
  - feature-extraction
  - sentence-similarity
pretty_name: ms-marco-mini
tags:
  - sentence-transformers
  - colbert
  - lightonai
dataset_info:
  - config_name: triplet
    features:
      - name: query
        dtype: string
      - name: positive
        dtype: string
      - name: negative
        dtype: string
    splits:
      - name: train
        num_examples: 30
  - config_name: queries
    features:
      - name: query_id
        dtype: string
      - name: text
        dtype: string
    splits:
      - name: train
        num_examples: 19
  - config_name: documents
    features:
      - name: document_id
        dtype: string
      - name: text
        dtype: string
    splits:
      - name: train
        num_examples: 32
  - config_name: train
    features:
      - name: query_id
        dtype: string
      - name: document_ids
        sequence:
          value:
            dtype: string
      - name: scores
        sequence:
          value:
            dtype: float16
    splits:
      - name: train
        num_examples: 19
configs:
  - config_name: triplet
    data_files:
      - split: train
        path: triplet.parquet
  - config_name: queries
    data_files:
      - split: train
        path: queries.parquet
  - config_name: documents
    data_files:
      - split: train
        path: documents.parquet
  - config_name: train
    data_files:
      - split: train
        path: train.parquet

ms-marco-mini

This dataset gathers very few samples from MS MARCO to provide an example of triplet-based / knowledge distillation dataset formatting.

triplet subset

The triplet file is all we need to fine-tune a model based on contrastive loss.

  • Columns: "query", "positive", "negative"
  • Column types: str, str, str
  • Examples:
    {
      "query": "what are the liberal arts?",
      "positive": 'liberal arts. 1. the academic course of instruction at a college intended to provide general knowledge and comprising the arts, humanities, natural sciences, and social sciences, as opposed to professional or technical subjects.',
      "negative": 'The New York State Education Department requires 60 Liberal Arts credits in a Bachelor of Science program and 90 Liberal Arts credits in a Bachelor of Arts program. In the list of course descriptions, courses which are liberal arts for all students are identified by (Liberal Arts) after the course number.'
    }
    
  • Datasets
    from datasets import load_dataset
    
    dataset = load_dataset("lightonai/lighton-ms-marco-mini", "triplet", split="train") 
    

knowledge distillation subset

To fine-tune a model using knowledge distillation loss we will need three distinct file:

  • Datasets
    from datasets import load_dataset
    
    train = load_dataset(
        "lightonai/lighton-ms-marco-mini",
        "train",
        split="train",
    )
    
    queries = load_dataset(
        "lightonai/lighton-ms-marco-mini",
        "queries",
        split="train",
    )
    
    documents = load_dataset(
        "lightonai/lighton-ms-marco-mini",
        "documents",
        split="train",
    )
    

Where:

  • train contains three distinct columns: ['query_id', 'document_ids', 'scores']
{
    "query_id": 54528,
    "document_ids": [
        6862419,
        335116,
        339186,
        7509316,
        7361291,
        7416534,
        5789936,
        5645247,
    ],
    "scores": [
        0.4546215673141326,
        0.6575686537173476,
        0.26825184192900203,
        0.5256195579370395,
        0.879939718687207,
        0.7894968184862693,
        0.6450100468854655,
        0.5823844608171467,
    ],
}

Assert that the length of document_ids is the same as scores.

  • queries contains two distinct columns: ['query_id', 'text']
{"query_id": 749480, "text": "what is function of magnesium in human body"}
  • documents contains two distinct columns: ['document_ids', 'text']
{
    "document_id": 136062,
    "text": "2. Also called tan .a fundamental trigonometric function that, in a right triangle, is expressed as the ratio of the side opposite an acute angle to the side adjacent to that angle. 3. in immediate physical contact; touching; abutting. 4. a. touching at a single point, as a tangent in relation to a curve or surface.lso called tan .a fundamental trigonometric function that, in a right triangle, is expressed as the ratio of the side opposite an acute angle to the side adjacent to that angle. 3. in immediate physical contact; touching; abutting. 4. a. touching at a single point, as a tangent in relation to a curve or surface.",
}