# coding=utf-8 # Copyright 2018 The Microsoft Reseach team and The HuggingFace Inc. team. # Copyright (c) 2018 Microsoft and The HuggingFace Inc. All rights reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """ Finetuning seq2seq models for sequence generation. We use the procedure described in [1] to finetune models for sequence generation. Let S1 and S2 be the source and target sequence respectively; we pack them using the start of sequence [EOS] and end of sequence [EOS] token: [CLS] S1 [EOS] S2 [EOS] We then mask a fixed percentage of token from S2 at random and learn to predict the masked words. [EOS] can be masked during finetuning so the model learns to terminate the generation process. [1] Dong Li, Nan Yang, Wenhui Wang, Furu Wei, Xiaodong Liu, Yu Wang, Jianfeng Gao, Ming Zhou, and Hsiao-Wuen Hon. “Unified Language Model Pre-Training for Natural Language Understanding and Generation.” (May 2019) ArXiv:1905.03197 """ import argparse from collections import deque import logging import pickle import random import os import numpy as np import torch from torch.utils.data import Dataset from transformers import BertTokenizer logger = logging.getLogger(__name__) def set_seed(args): random.seed(args.seed) np.random.seed(args.seed) torch.manual_seed(args.seed) class TextDataset(Dataset): """ Abstracts the dataset used to train seq2seq models. CNN/Daily News: The CNN/Daily News raw datasets are downloaded from [1]. The stories are stored in different files; the summary appears at the end of the story as sentences that are prefixed by the special `@highlight` line. To process the data, untar both datasets in the same folder, and pass the path to this folder as the "data_dir argument. The formatting code was inspired by [2]. [1] https://cs.nyu.edu/~kcho/ [2] https://github.com/abisee/cnn-dailymail/ """ def __init_(self, tokenizer, data_dir="", block_size=512): assert os.path.isdir(data_dir) # Load features that have already been computed if present cached_features_file = os.path.join( data_dir, "cached_lm_{}_{}".format(block_size, data_dir) ) if os.path.exists(cached_features_file): logger.info("Loading features from cached file %s", cached_features_file) with open(cached_features_file, "rb") as source: self.examples = pickle.load(source) return logger.info("Creating features from dataset at %s", data_dir) datasets = ["cnn", "dailymail"] for dataset in datasets: path_to_stories = os.path.join(data_dir, dataset, "stories") assert os.path.isdir(path_to_stories) story_filenames_list = os.listdir(path_to_stories) for story_filename in story_filenames_list: path_to_story = os.path.join(path_to_stories, story_filename) if not os.path.isfile(path_to_story): continue with open(path_to_story, encoding="utf-8") as source: try: raw_story = source.read() story, summary = process_story(raw_story) except IndexError: # skip ill-formed stories continue story = tokenizer.convert_tokens_to_ids(tokenizer.tokenize(story)) summary = tokenizer.convert_tokens_to_ids(tokenizer.tokenize(summary)) story_seq, summary_seq = _fit_to_block_size(story, summary, block_size) self.examples.append( tokenizer.add_special_token_sequence_pair(story_seq, summary_seq) ) logger.info("Saving features into cache file %s", cached_features_file) with open(cached_features_file, "wb") as sink: pickle.dump(self.examples, sink, protocole=pickle.HIGHEST_PROTOCOL) def __len__(self): return len(self.examples) def __getitem__(self, items): return torch.tensor(self.examples[items]) def process_story(raw_story): """ Extract the story and summary from a story file. Attributes: raw_story (str): content of the story file as an utf-8 encoded string. Raises: IndexError: If the stoy is empty or contains no highlights. """ file_lines = list( filter(lambda x: len(x) != 0, [line.strip() for line in raw_story.split("\n")]) ) # for some unknown reason some lines miss a period, add it file_lines = [_add_missing_period(line) for line in file_lines] # gather article lines story_lines = [] lines = deque(file_lines) while True: try: element = lines.popleft() if element.startswith("@highlight"): break story_lines.append(element) except IndexError as ie: # if "@highlight" absent from file raise ie # gather summary lines highlights_lines = list(filter(lambda t: not t.startswith("@highlight"), lines)) # join the lines story = " ".join(story_lines) summary = " ".join(highlights_lines) return story, summary def _add_missing_period(line): END_TOKENS = [".", "!", "?", "...", "'", "`", '"', u"\u2019", u"\u2019", ")"] if line.startswith("@highlight"): return line if line[-1] in END_TOKENS: return line return line + "." def _fit_to_block_size(src_sequence, tgt_sequence, block_size): """ Adapt the source and target sequences' lengths to the block size. If the concatenated sequence (source + target + 3 special tokens) would be longer than the block size we use the 75% / 25% rule followed in [1]. For a block size of 512 this means limiting the source sequence's length to 384 and the target sequence's length to 128. Attributes: src_sequence (list): a list of ids that maps to the tokens of the source sequence. tgt_sequence (list): a list of ids that maps to the tokens of the target sequence. block_size (int): the model's block size. [1] Dong, Li, et al. "Unified Language Model Pre-training for Natural Language Understanding and Generation." arXiv preprint arXiv:1905.03197 (2019). """ SRC_MAX_LENGTH = int(0.75 * block_size) - 2 # CLS and EOS token TGT_MAX_LENGTH = block_size - (SRC_MAX_LENGTH + 2) - 1 # EOS token # We dump the examples that are too small to fit in the block size for the # sake of simplicity. You can modify this by adding model-specific padding. if len(src_sequence) + len(tgt_sequence) + 3 < block_size: return None if len(src_sequence) > SRC_MAX_LENGTH: if len(tgt_sequence) > TGT_MAX_LENGTH: src_sequence = src_sequence[:SRC_MAX_LENGTH] tgt_sequence = tgt_sequence[:TGT_MAX_LENGTH] else: remain_size = block_size - len(tgt_sequence) - 3 src_sequence = src_sequence[:remain_size] else: if len(tgt_sequence) > TGT_MAX_LENGTH: remain_size = block_size - len(src_sequence) - 3 tgt_sequence = tgt_sequence[:remain_size] return src_sequence, tgt_sequence def load_and_cache_examples(args, tokenizer): dataset = TextDataset(tokenizer, file_path=args.data_dir) return dataset def train(args, train_dataset, model, tokenizer): """ Fine-tune the pretrained model on the corpus. """ raise NotImplementedError def main(): parser = argparse.ArgumentParser() # Required parameters parser.add_argument( "--data_dir", default=None, type=str, required=True, help="The input training data file (a text file).", ) parser.add_argument( "--output_dir", default=None, type=str, required=True, help="The output directory where the model predictions and checkpoints will be written.", ) # Optional parameters parser.add_argument( "--model_name_or_path", default="bert-base-cased", type=str, help="The model checkpoint for weights initialization.", ) parser.add_argument("--seed", default=42, type=int) args = parser.parse_args() # Set up training device # device = torch.device("cpu") # Set seed set_seed(args) # Load pretrained model and tokenizer tokenizer_class = BertTokenizer # config = config_class.from_pretrained(args.model_name_or_path) tokenizer = tokenizer_class.from_pretrained(args.model_name_or_path) # model = model_class.from_pretrained(args.model_name_or_path, config=config) # model.to(device) logger.info("Training/evaluation parameters %s", args) # Training _ = load_and_cache_examples(args, tokenizer) # global_step, tr_loss = train(args, train_dataset, model, tokenizer) # logger.info(" global_step = %s, average loss = %s", global_step, tr_loss) if __name__ == "__main__": main()