GenerateTextClassificationData¶
Generate text classification data with an LLM to later on train an embedding model.
GenerateTextClassificationData is a Task that generates text classification data with an
    LLM to later on train an embedding model. The task is based on the paper "Improving
    Text Embeddings with Large Language Models" and the data is generated based on the
    provided attributes, or randomly sampled if not provided.
Note¶
Ideally this task should be used with EmbeddingTaskGenerator with flatten_tasks=True
with the category="text-classification"; so that the LLM generates a list of tasks that
are flattened so that each row contains a single task for the text-classification category.
Attributes¶
- 
language: The language of the data to be generated, which can be any of the languages retrieved from the list of XLM-R in the Appendix A of https://aclanthology.org/2020.acl-main.747.pdf. 
- 
difficulty: The difficulty of the query to be generated, which can be high school,college, orPhD. Defaults toNone, meaning that it will be randomly sampled.
- 
clarity: The clarity of the query to be generated, which can be clear,understandable with some effort, orambiguous. Defaults toNone, meaning that it will be randomly sampled.
- 
seed: The random seed to be set in case there's any sampling within the format_inputmethod.
Input & Output Columns¶
graph TD
    subgraph Dataset
        subgraph Columns
            ICOL0[task]
        end
        subgraph New columns
            OCOL0[input_text]
            OCOL1[label]
            OCOL2[misleading_label]
            OCOL3[model_name]
        end
    end
    subgraph GenerateTextClassificationData
        StepInput[Input Columns: task]
        StepOutput[Output Columns: input_text, label, misleading_label, model_name]
    end
    ICOL0 --> StepInput
    StepOutput --> OCOL0
    StepOutput --> OCOL1
    StepOutput --> OCOL2
    StepOutput --> OCOL3
    StepInput --> StepOutput
Inputs¶
- task (str): The task description to be used in the generation.
Outputs¶
- 
input_text ( str): the input text generated by theLLM.
- 
label ( str): the label generated by theLLM.
- 
misleading_label ( str): the misleading label generated by theLLM.
- 
model_name ( str): the name of the model used to generate the text classification data.
Examples¶
Generate synthetic text classification data for training embedding models¶
from distilabel.pipeline import Pipeline
from distilabel.steps.tasks import EmbeddingTaskGenerator, GenerateTextClassificationData
with Pipeline("my-pipeline") as pipeline:
    task = EmbeddingTaskGenerator(
        category="text-classification",
        flatten_tasks=True,
        llm=...,  # LLM instance
    )
    generate = GenerateTextClassificationData(
        language="English",
        difficulty="high school",
        clarity="clear",
        llm=...,  # LLM instance
    )
    task >> generate