Sesuaikan alur kerja Anda menggunakan pustaka fmeval

Buat kustom ModelRunner

1. Tentukan konfigurasi model.

   Contoh kode berikut menunjukkan cara menerapkan dataclass dekorator ke HFModelConfig kelas khusus sehingga Anda dapat menentukan konfigurasi model untuk Hugging Facemodel:

   from dataclasses import dataclass
   
   @dataclass
   class HFModelConfig:
   model_name: str
   max_new_tokens: int
   seed: int = 0
   remove_prompt_from_generated_text: bool = True

   Pada contoh kode sebelumnya, hal berikut berlaku:

   • Parameter max_new_tokens ini digunakan untuk membatasi panjang respons dengan membatasi jumlah token yang dikembalikan oleh LLM. Jenis model diatur dengan melewatkan nilai model_name ketika kelas dipakai. Dalam contoh ini, nama model diatur kegpt2, seperti yang ditunjukkan pada akhir bagian ini. Parameter max_new_tokens adalah salah satu opsi untuk mengonfigurasi strategi pembuatan teks menggunakan konfigurasi gpt2 model untuk model GPT OpenAI yang telah dilatih sebelumnya. Lihat AutoConfiguntuk jenis model lainnya.

   • Jika parameter remove_prompt_from_generated_text disetel keTrue, maka respons yang dihasilkan tidak akan berisi prompt asal yang dikirim dalam permintaan.

   Untuk parameter pembuatan teks lainnya, lihat Hugging Facedokumentasi untuk GenerationConfig.

2. Buat kustom ModelRunner dan terapkan metode prediksi. Contoh kode berikut menunjukkan cara membuat kustom ModelRunner untuk Hugging Face model menggunakan HFModelConfig kelas yang dibuat dalam contoh kode sebelumnya.

   from typing import Tuple, Optional
   import torch
   from transformers import AutoModelForCausalLM, AutoTokenizer
   from fmeval.model_runners.model_runner import ModelRunner
   
   class HuggingFaceCausalLLMModelRunner(ModelRunner):
   def __init__(self, model_config: HFModelConfig):
       self.config = model_config
       self.model = AutoModelForCausalLM.from_pretrained(self.config.model_name)
       self.tokenizer = AutoTokenizer.from_pretrained(self.config.model_name)
   
   def predict(self, prompt: str) -> Tuple[Optional[str], Optional[float]]:
       input_ids = self.tokenizer(prompt, return_tensors="pt").to(self.model.device)
       generations = self.model.generate(
           **input_ids,
           max_new_tokens=self.config.max_new_tokens,
           pad_token_id=self.tokenizer.eos_token_id,
       )
       generation_contains_input = (
           input_ids["input_ids"][0] == generations[0][: input_ids["input_ids"].shape[1]]
       ).all()
       if self.config.remove_prompt_from_generated_text and not generation_contains_input:
           warnings.warn(
               "Your model does not return the prompt as part of its generations. "
               "`remove_prompt_from_generated_text` does nothing."
           )
       if self.config.remove_prompt_from_generated_text and generation_contains_input:
           output = self.tokenizer.batch_decode(generations[:, input_ids["input_ids"].shape[1] :])[0]
       else:
           output = self.tokenizer.batch_decode(generations, skip_special_tokens=True)[0]
   
       with torch.inference_mode():
           input_ids = self.tokenizer(self.tokenizer.bos_token + prompt, return_tensors="pt")["input_ids"]
           model_output = self.model(input_ids, labels=input_ids)
           probability = -model_output[0].item()
   
       return output, probability

   Kode sebelumnya menggunakan HuggingFaceCausalLLMModelRunner kelas kustom yang mewarisi properti dari FMEval ModelRunner kelas. Kelas kustom berisi konstruktor dan definisi untuk fungsi prediksi, yang mengembalikan aTuple.

   Untuk ModelRunner contoh lainnya, lihat bagian model_runner dari pustaka. fmeval

   HuggingFaceCausalLLMModelRunnerKonstruktor berisi definisi berikut:

   • Konfigurasi diatur keHFModelConfig, didefinisikan di awal bagian ini.

   • Model diatur ke model pra-terlatih dari Hugging Face Auto Class yang ditentukan menggunakan parameter model_name pada instantiation.

   • Tokenizer diatur ke kelas dari pustaka Hugging Face tokenizer yang cocok dengan model pra-terlatih yang ditentukan oleh. model_name

   Menggunakan metode predict pada kelas HuggingFaceCausalLLMModelRunner yang ditentukan dalam contoh berikut.

   • input_ids— Variabel yang berisi masukan untuk model Anda. Model menghasilkan input sebagai berikut.

     • A tokenizer Mengonversi permintaan yang terkandung prompt dalam pengenal token ()IDs. Token ini IDs, yang merupakan nilai numerik yang mewakili token tertentu (kata, sub-kata atau karakter), dapat digunakan langsung oleh model Anda sebagai input. Token IDs dikembalikan sebagai objek PyTorch tensor, seperti yang ditentukan olehreturn_tensors="pt". Untuk tipe tipe tensor kembali lainnya, lihat Hugging Face dokumentasi untuk apply_chat_template.

     • Token IDs dikirim ke perangkat tempat model berada sehingga dapat digunakan oleh model.

   • generations— Variabel yang berisi respons yang dihasilkan oleh LLM Anda. Fungsi generate model menggunakan input berikut untuk menghasilkan respons:

     • input_idsDari langkah sebelumnya.

     • Parameter max_new_tokens yang ditentukan dalamHFModelConfig.

     • A pad_token_id menambahkan token akhir kalimat (eos) ke respons. Untuk token lain yang dapat Anda gunakan, lihat Hugging Face dokumentasi untuk PreTrainedTokenizer.

   • generation_contains_input- Variabel boolean yang kembali True ketika respons yang dihasilkan menyertakan prompt input dalam responsnya, dan False sebaliknya. Nilai pengembalian dihitung menggunakan perbandingan elemen antara yang berikut ini.

     • Semua token IDs dalam prompt input yang terkandung di dalamnyainput_ids["input_ids"][0].

     • Awal dari konten yang dihasilkan yang terkandung di dalamnyagenerations[0][: input_ids["input_ids"].shape[1]].

     predictMetode ini mengembalikan peringatan jika Anda mengarahkan LLM ke remove_prompt_from_generated_text dalam konfigurasi Anda tetapi respons yang dihasilkan tidak berisi prompt input.

     Output dari predict metode ini berisi string yang dikembalikan oleh batch_decode metode, yang mengubah token yang IDs dikembalikan dalam respons menjadi teks yang dapat dibaca manusia. Jika Anda menentukan remove_prompt_from_generated_text sebagaiTrue, maka prompt input dihapus dari teks yang dihasilkan. Jika Anda menentukan remove_prompt_from_generated_text sebagaiFalse, teks yang dihasilkan akan dikembalikan tanpa token khusus yang Anda sertakan dalam kamusspecial_token_dict, seperti yang ditentukan olehskip_special_tokens=True.

3. Uji AndaModelRunner. Kirim permintaan sampel ke model Anda.

   Contoh berikut menunjukkan cara menguji model menggunakan model gpt2 pra-terlatih dari Hugging Face AutoConfig kelas:

   hf_config = HFModelConfig(model_name="gpt2", max_new_tokens=32)
   model = HuggingFaceCausalLLMModelRunner(model_config=hf_config)

   Dalam contoh kode sebelumnya, model_name tentukan nama model pra-terlatih. HFModelConfigKelas ini dipakai sebagai hf_config dengan nilai untuk parametermax_new_tokens, dan digunakan untuk menginisialisasi. ModelRunner

   Jika Anda ingin menggunakan model pra-terlatih lainnyaHugging Face, pilih pretrained_model_name_or_path di from_pretrained bawah AutoClass.

   Terakhir, uji AndaModelRunner. Kirim permintaan sampel ke model Anda seperti yang ditunjukkan dalam contoh kode berikut:

   model_output = model.predict("London is the capital of?")[0]
   print(model_output)
   eval_algo.evaluate_sample()