Transformers documentation

Engenharia de prompt

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v5.22.1).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Engenharia de prompt

A engenharia de prompts, ou simplesmente prompting, utiliza linguagem natural para melhorar o desempenho de modelos de linguagem de grande escala (LLMs) em uma variedade de tarefas. Um prompt pode direcionar o modelo para gerar a saída desejada. Em muitos casos, você nem precisa de um modelo fine-tuned para uma tarefa. Basta um bom prompt.

Experimente pedir a um LLM que classifique algum texto. Ao criar um prompt, é importante fornecer instruções muito específicas sobre a tarefa e sobre como o resultado deve ser.

from transformers import pipeline
import torch

pipeline = pipeline(task="text-generation", model="mistralai/Mistral-7B-Instruct-v0.1", dtype=torch.bfloat16, device_map="auto")
prompt = """Classify the text into neutral, negative or positive.
Text: This movie is definitely one of my favorite movies of its kind. The interaction between respectable and morally strong characters is an ode to chivalry and the honor code amongst thieves and policemen.
Sentiment:
"""

outputs = pipeline(prompt, max_new_tokens=10)
for output in outputs:
    print(f"Result: {output['generated_text']}")
Result: Classify the text into neutral, negative or positive. 
Text: This movie is definitely one of my favorite movies of its kind. The interaction between respectable and morally strong characters is an ode to chivalry and the honor code amongst thieves and policemen.
Sentiment:
Positive

O desafio reside em projetar prompts que produzam os resultados que você espera, pois a linguagem é extremamente matizada e expressiva.

Este guia aborda as melhores práticas, técnicas e exemplos de engenharia de prompts para resolver tarefas de linguagem e raciocínio.

Boas práticas

  1. Tente escolher os modelos mais recentes para obter o melhor desempenho. Lembre-se de que os LLMs podem vir em duas variantes, base e instruction-tuned (ou chat).

    Os modelos base são excelentes em completar texto a partir de um prompt inicial, mas não são tão bons em seguir instruções. Os modelos ajustados por instrução são versões específicas dos modelos base, treinadas com dados instrucionais ou conversacionais. Isso torna os modelos ajustados por instrução mais adequados para o uso de prompts.

    Os LLMs modernos são tipicamente modelos apenas de decodificador, mas existem alguns LLMs encoder-decoder, como Flan-T5 ou BART, que podem ser usados para prompting. Carregue esses modelos diretamente com a classe AutoModelForSeq2SeqLM (em vez de usar Pipeline) e gere as saídas a partir do próprio modelo.

  2. Comece com um prompt curto e simples e itere sobre ele para obter melhores resultados.

  3. Coloque as instruções no início ou no final de um prompt. Para prompts mais longos, os modelos podem aplicar otimizações para evitar que a atenção escale de forma quadrática, o que dá mais ênfase ao início e ao final de um prompt.

  4. Separe claramente as instruções do texto de interesse.

  5. Seja específico e descritivo sobre a tarefa e a saída desejada, incluindo, por exemplo, seu formato, comprimento, estilo e idioma. Evite descrições e instruções ambíguas.

  6. As instruções devem focar no “o que fazer” em vez do “o que não fazer”.

  7. Guie o modelo para gerar a saída correta escrevendo a primeira palavra ou até mesmo a primeira frase.

  8. Experimente outras técnicas, como few-shot e chain-of-thought, para melhorar os resultados.

  9. Teste seus prompts com diferentes modelos para avaliar sua robustez.

  10. Versionar e acompanhar o desempenho dos seus prompts.

Técnicas

Criar um bom prompt por si só, também conhecido como zero-shot prompting, pode não ser suficiente para obter os resultados desejados. Você pode precisar experimentar algumas técnicas de prompting para alcançar o melhor desempenho.

Esta seção aborda algumas técnicas de prompt.

Prompting com poucos exemplos

O few-shot prompting melhora a precisão e o desempenho ao incluir exemplos específicos do que um modelo deve gerar a partir de uma entrada. Os exemplos explícitos fornecem ao modelo uma melhor compreensão da tarefa e do formato de saída desejado. Experimente com diferentes quantidades de exemplos (2, 4, 8, etc.) para observar como isso afeta o desempenho. O exemplo abaixo fornece ao modelo 1 exemplo (1-shot) do formato de saída (uma data no formato MM/DD/AAAA) que ele deve retornar.

from transformers import pipeline
import torch

pipeline = pipeline(model="mistralai/Mistral-7B-Instruct-v0.1", dtype=torch.bfloat16, device_map="auto")
prompt = """Text: The first human went into space and orbited the Earth on April 12, 1961.
Date: 04/12/1961
Text: The first-ever televised presidential debate in the United States took place on September 28, 1960, between presidential candidates John F. Kennedy and Richard Nixon.
Date:"""

outputs = pipeline(prompt, max_new_tokens=12, do_sample=True, top_k=10)
for output in outputs:
    print(f"Result: {output['generated_text']}")
# Result: Text: The first human went into space and orbited the Earth on April 12, 1961.
# Date: 04/12/1961
# Text: The first-ever televised presidential debate in the United States took place on September 28, 1960, between presidential candidates John F. Kennedy and Richard Nixon.
# Date: 09/28/1960

A desvantagem do few-shot prompting é que é necessário criar prompts mais longos, o que aumenta a computação e a latência. Além disso, há um limite para o comprimento dos prompts. Por fim, um modelo pode aprender padrões indesejados a partir dos seus exemplos e pode não funcionar bem em tarefas de raciocínio complexo.

Para melhorar o few-shot prompting em LLMs modernos ajustados por instruções, utilize o chat template específico do modelo. Esses modelos são treinados em conjuntos de dados com conversas por turnos entre um “user” e um “assistant”. Estruturar seu prompt de forma a se alinhar a isso pode melhorar o desempenho.

Estruture seu prompt como uma conversa por turnos e use o método apply_chat_template para tokenizar e formatá-lo.

from transformers import pipeline
import torch

pipeline = pipeline(model="mistralai/Mistral-7B-Instruct-v0.1", dtype=torch.bfloat16, device_map="auto")

messages = [
    {"role": "user", "content": "Text: The first human went into space and orbited the Earth on April 12, 1961."},
    {"role": "assistant", "content": "Date: 04/12/1961"},
    {"role": "user", "content": "Text: The first-ever televised presidential debate in the United States took place on September 28, 1960, between presidential candidates John F. Kennedy and Richard Nixon."}
]

prompt = pipeline.tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)

outputs = pipeline(prompt, max_new_tokens=12, do_sample=True, top_k=10)

for output in outputs:
    print(f"Result: {output['generated_text']}")

Enquanto a abordagem básica de few-shot prompting incorporava exemplos em uma única string de texto, o formato de template de chat oferece os seguintes benefícios.

  • O modelo pode ter uma compreensão potencialmente aprimorada, pois consegue reconhecer melhor o padrão e os papéis esperados da entrada do usuário e da saída do assistente.
  • O modelo pode produzir o formato de saída desejado de forma mais consistente, pois sua estrutura é semelhante à do seu input durante o treinamento.

Consulte sempre a documentação de um modelo específico ajustado por instruções para conhecer o formato do template de chat e estruturar seus prompts few-shot de acordo.

Cadeia de raciocínio

Chain-of-thought (CoT) é eficaz na geração de saídas mais coerentes e bem fundamentadas, fornecendo uma série de prompts que ajudam o modelo a “pensar” de forma mais aprofundada sobre um tópico.

O exemplo abaixo fornece ao modelo vários prompts para trabalhar etapas intermediárias de raciocínio.

from transformers import pipeline
import torch

pipeline = pipeline(model="mistralai/Mistral-7B-Instruct-v0.1", dtype=torch.bfloat16, device_map="auto")
prompt = """Let's go through this step-by-step:
1. You start with 15 muffins.
2. You eat 2 muffins, leaving you with 13 muffins.
3. You give 5 muffins to your neighbor, leaving you with 8 muffins.
4. Your partner buys 6 more muffins, bringing the total number of muffins to 14.
5. Your partner eats 2 muffins, leaving you with 12 muffins.
If you eat 6 muffins, how many are left?"""

outputs = pipeline(prompt, max_new_tokens=20, do_sample=True, top_k=10)
for output in outputs:
    print(f"Result: {output['generated_text']}")
Result: Let's go through this step-by-step:
1. You start with 15 muffins.
2. You eat 2 muffins, leaving you with 13 muffins.
3. You give 5 muffins to your neighbor, leaving you with 8 muffins.
4. Your partner buys 6 more muffins, bringing the total number of muffins to 14.
5. Your partner eats 2 muffins, leaving you with 12 muffins.
If you eat 6 muffins, how many are left?
Answer: 6

Assim como o few-shot prompting, a desvantagem do CoT é que ele exige mais esforço para projetar uma série de prompts que ajudem o modelo a raciocinar sobre uma tarefa complexa, e o aumento do comprimento do prompt eleva a latência.

Ajuste fino

Embora o prompting seja uma forma poderosa de trabalhar com LLMs, existem cenários em que um modelo ajustado finamente, ou até mesmo o ajuste fino de um modelo, funciona melhor.

Aqui estão alguns cenários em que um modelo ajustado faz sentido.

  • Seu domínio é extremamente diferente do que um LLM foi pré-treinado, e o uso extensivo de prompts não produziu os resultados que você deseja.
  • Seu modelo precisa funcionar bem em um idioma com poucos recursos.
  • Seu modelo precisa ser treinado em dados sensíveis que possuem requisitos regulatórios rigorosos.
  • Você está usando um modelo pequeno devido a custos, privacidade, infraestrutura ou outras restrições.

Em todos esses cenários, verifique se você possui um conjunto de dados específico do domínio grande o suficiente para treinar seu modelo, se tem tempo e recursos suficientes e se o custo do ajuste fino compensa. Caso contrário, talvez seja melhor tentar otimizar seu prompt.

Exemplos

Os exemplos abaixo demonstram o uso de prompts em um LLM para diferentes tarefas.

reconhecimento de entidades nomeadas
tradução
sumarização
resposta a perguntas
from transformers import pipeline
import torch

pipeline = pipeline(model="mistralai/Mistral-7B-Instruct-v0.1", dtype=torch.bfloat16, device_map="auto")
prompt = """Return a list of named entities in the text.
Text: The company was founded in 2016 by French entrepreneurs Clément Delangue, Julien Chaumond, and Thomas Wolf in New York City, originally as a company that developed a chatbot app targeted at teenagers.
Named entities:
"""

outputs = pipeline(prompt, max_new_tokens=50, return_full_text=False)
for output in outputs:
    print(f"Result: {output['generated_text']}")
Result:  [Clément Delangue, Julien Chaumond, Thomas Wolf, company, New York City, chatbot app, teenagers]
Update on GitHub