transformers-lightning

###########################################

The project has been moved to transformers-framework. This library is not updated anymore.

############################################

Transformers-Lightning was a collection of adapters, callbacks, datamodules, datasets, language-modeling, loggers, models, schedulers and optimizers to better integrate PyTorch Lightning and Transformers.

I'm happy to announce that all the metrics contained in this package has been successfully integrated into torchmetrics.

Table of contents

1. Install

2. Documentation

• 2.1. Adapters
• 2.2. Datasets
• 2.3. Datamodules
• 2.4. Callbacks
• 2.5. Models
• 2.6. Language modeling
• 2.7. Loggers
• 2.8. Schedulers
• 2.9. Optimizers

3. Main file

Install

Install the last stable release with

pip install transformers-lightning

You can also install a particular older version, for example the 0.5.4 by doing:

pip install git+https://github.com/iKernels/transformers-lightning.git@0.5.4 --upgrade

Documentation

The documentation of each component is described in the relative folder.

Main file

We encourage you to structure your main file like:

import os
from argparse import ArgumentParser

import pytorch_lightning as pl
import torch

import models
import datamodules

from transformers_lightning import utils, callbacks, datamodules
from transformers_lightning.defaults import DefaultConfig


# Print high precision tensor values
torch.set_printoptions(precision=16)

def main(hyperparameters):

    # instantiate PL model
    model = TransformerModel(hyperparameters)

    # default tensorboard logger
    test_tube_logger = pl.loggers.TestTubeLogger(
        os.path.join(hyperparameters.output_dir, hyperparameters.tensorboard_dir), name=hyperparameters.name
    )

    # Save pre-trained models to
    save_transformers_callback = callbacks.TransformersModelCheckpointCallback(hyperparameters)

    # instantiate PL trainer
    trainer = pl.Trainer.from_argparse_args(
        hyperparameters,
        default_root_dir=hyperparameters.output_dir,
        profiler=True,
        logger=test_tube_logger,
        callbacks=[save_transformers_callback],
        log_gpu_memory='all',
        weights_summary='full'
    )

    # Datasets
    datamodule = YourDataModule(hyperparameters, model, trainer)

    # Train!
    if datamodule.do_train():
        trainer.fit(model, datamodule=datamodule)

    # Test!
    if datamodule.do_test():
        trainer.test(model, datamodule=datamodule)


if __name__ == '__main__':

    parser = ArgumentParser()

    # Experiment name, used both for checkpointing, pre_trained_names, logging and tensorboard
    parser.add_argument('--name', type=str, required=True, help='Name of the experiment, well be used to correctly retrieve checkpoints and logs')

    # I/O folders
    DefaultConfig.add_argparse_args(parser)

    # add model specific cli arguments
    TransformerModel.add_argparse_args(parser)
    YourDataModule.add_argparse_args(parser)

    # add callback / logger specific cli arguments
    callbacks.TransformersModelCheckpointCallback.add_argparse_args(parser)

    # add all the available trainer options to argparse
    # ie: now --gpus --num_nodes ... --fast_dev_run all work in the cli
    pl.Trainer.add_argparse_args(parser)

    # get NameSpace of parameters
    hyperparameters = parser.parse_args()
    main(hyperparameters)

Tests

To run tests you should start by installing pytest:

pip install pytest

Now, you can run tests (from the main folder), by running for example:

python -m pytest tests/callbacks

to only test callbacks or

python -m pytest tests

to run every test.