Skip to main content

A Pytorch implementation of Proximal Policy Optimization for transfomer language models.

Project description

Welcome to Transformer Reinforcement Learning (trl)

Train transformer language models with reinforcement learning.

What is it?

With trl you can train transformer language models with Proximal Policy Optimization (PPO). The library is built with the transformer library by 🤗 Hugging Face (link). Therefore, pre-trained language models can be directly loaded via the transformer interface. At this point only GTP2 is implemented.

Highlights:

  • GPT2 model with a value head: A transformer model with an additional scalar output for each token which can be used as a value function in reinforcement learning.
  • PPOTrainer: A PPO trainer for language models that just needs (query, response, reward) triplets to optimise the language model.
  • Example: Train GPT2 to generate positive movie reviews with a BERT sentiment classifier.

How it works

Fine-tuning a language model via PPO consists of roughly three steps:

  1. Rollout: The language model generates a response or continuation based on query which could be the start of a sentence.
  2. Evaluation: The query and response are evaluated with a function, model, human feedback or some combination of them. The important thing is that this process should yield a scalar value for each query/response pair.
  3. Optimization: This is the most complex part. In the optimisation step the query/response pairs are used to calculate the log-probabilities of the tokens in the sequences. This is done with the model that is trained and and a reference model, which is usually the pre-trained model before fine-tuning. The KL-divergence between the two outputs is used as an additional reward signal to make sure the generated responses don't deviate to far from the reference language model. The active language model is then trained with PPO.

This process is illustrated in the sketch below:

Figure: Sketch of the workflow.

Installation

Python package

Install the library with pip:

pip install trl

Repository

If you want to run the examples in the repository a few additional libraries are required. Clone the repository and install it with pip:

git clone https://github.com/lvwerra/trl.git

cd tlr/

pip install -r requirements.txt

Jupyter notebooks

If you run Jupyter notebooks you might need to run the following:

jupyter nbextension enable --py --sys-prefix widgetsnbextension

For Jupyterlab additionally this command:

jupyter labextension install @jupyter-widgets/jupyterlab-manager

How to use

Example

This is a basic example on how to use the library. Based on a query the language model creates a response which is then evaluated. The evaluation could be a human in the loop or another model's output.

# imports
import torch
from transformers import GPT2Tokenizer
from trl.gpt2 import GPT2HeadWithValueModel, respond_to_batch
from trl.ppo import PPOTrainer

# get models
gpt2_model = GPT2HeadWithValueModel.from_pretrained('gpt2')
gpt2_model_ref = GPT2HeadWithValueModel.from_pretrained('gpt2')
gpt2_tokenizer = GPT2Tokenizer.from_pretrained('gpt2')

# initialize trainer
ppo_config = {'batch_size': 1, 'forward_batch_size': 1}
ppo_trainer = PPOTrainer(gpt2_model, gpt2_model_ref, **ppo_config)

# encode a query
query_txt = "This morning I went to the "
query_tensor = gpt2_tokenizer.encode(query_txt, return_tensors="pt")

# get model response
response_tensor  = respond_to_batch(gpt2_model, query_tensor)
response_txt = gpt2_tokenizer.decode(response_tensor[0,:])

# define a reward for response
# (this could be any reward such as human feedback or output from another model)
reward = torch.tensor([1.0]) 

# train model with ppo
train_stats = ppo_trainer.step(query_tensor, response_tensor, reward)

Advanced example: IMDB sentiment

For a detailed example check out the notebook Tune GPT2 to generate positive reviews, where GPT2 is fine-tuned to generate positive movie reviews. An few examples from the language models before and after optimisation are given below:

Figure: A few review continuations before and after optimisation.

Notebooks

This library is built with nbdev and as such all the library code as well as examples are in Jupyter notebooks. The following list gives an overview:

  • index.ipynb: Generates the README and the overview page.
  • 00-core.ipynb: Contains the utility functions used throughout the library and examples.
  • 01-gpt2-with-value-head.ipynb: Implementation of a transformer compatible GPT2 model with an additional value head as well as a function to generate sequences.
  • 02-ppo.ipynb: Implementation of the PPOTrainer used to train language models.
  • 03-bert-imdb-training.ipynb: Training of BERT with simpletransformers to classify sentiment on the IMDB dataset.
  • 04-gpt2-sentiment-ppo-training.ipynb: Fine-tune GPT2 with the BERT sentiment classifier to produce positive movie reviews.
  • 05-gpt2-sentiment-control.ipynb: Fine-tune GPT2 with the BERT sentiment classifier to produce movie reviews with controlled sentiment.

References

Proximal Policy Optimisation

The PPO implementation largely follows the structure introduced in the paper "Fine-Tuning Language Models from Human Preferences" by D. Ziegler et al. [paper, code].

Language models

The language models utilize the transformer library by 🤗Hugging Face.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

trl-0.0.3.tar.gz (18.6 kB view details)

Uploaded Source

Built Distribution

trl-0.0.3-py3-none-any.whl (15.2 kB view details)

Uploaded Python 3

File details

Details for the file trl-0.0.3.tar.gz.

File metadata

  • Download URL: trl-0.0.3.tar.gz
  • Upload date:
  • Size: 18.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.3.3 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.5

File hashes

Hashes for trl-0.0.3.tar.gz
Algorithm Hash digest
SHA256 897ffd6553481f50465baa22a3fba5f0afc3225fc0f667c8d283bd8e5753bc70
MD5 3e1d2c9dcd8bb659a80280965088b095
BLAKE2b-256 2de5a0aca0a105c7a991330b178ff4128154b5c594a6ba7108f73cea381635e8

See more details on using hashes here.

File details

Details for the file trl-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: trl-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 15.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.3.3 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.5

File hashes

Hashes for trl-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 15af543cc31b8829b0bb1fe2e14cf802d7b4e439e1bed85ac88847310b0d57a7
MD5 2b1420055bac370fde868323667ca55d
BLAKE2b-256 baf2dc3a0ec63353526f8a5acc14c99b5d9aaa93bbb87281fc417a0bce270ecb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page