In this folder, we illustrate how to apply SimCTG and contrastive search on models with encoder-decoder structure.
1. SimCTG Installation: [Back to Top]
To install the SimCTG via pip, please run the following command.
pip install simctg --upgradeThe source code and the detailed tutorial of the simctg package are provided [here].
2. T5: [Back to Top]
To initialize the model, please run the command as below:
from simctg.simctgt5 import SimCTGT5
model_name = "flax-community/t5-base-cnn-dm"
model = SimCTGT5(model_name, special_token_list=[])Next, we prepare the input article as:
ARTICLE = """ New York (CNN)When Liana Barrientos was 23 years old, she got married in Westchester County, New York.
A year later, she got married again in Westchester County, but to a different man and without divorcing her first husband.
Only 18 days after that marriage, she got hitched yet again. Then, Barrientos declared "I do" five more times, sometimes only within two weeks of each other.
In 2010, she married once more, this time in the Bronx. In an application for a marriage license, she stated it was her "first and only" marriage.
Barrientos, now 39, is facing two criminal counts of "offering a false instrument for filing in the first degree," referring to her false statements on the
2010 marriage license application, according to court documents.
Prosecutors said the marriages were part of an immigration scam.
On Friday, she pleaded not guilty at State Supreme Court in the Bronx, according to her attorney, Christopher Wright, who declined to comment further.
After leaving court, Barrientos was arrested and charged with theft of service and criminal trespass for allegedly sneaking into the New York subway through an emergency exit, said Detective
Annette Markowski, a police spokeswoman. In total, Barrientos has been married 10 times, with nine of her marriages occurring between 1999 and 2002.
All occurred either in Westchester County, Long Island, New Jersey or the Bronx. She is believed to still be married to four men, and at one time, she was married to eight men at once, prosecutors say.
Prosecutors said the immigration scam involved some of her husbands, who filed for permanent residence status shortly after the marriages.
Any divorces happened only after such filings were approved. It was unclear whether any of the men will be prosecuted.
The case was referred to the Bronx District Attorney\'s Office by Immigration and Customs Enforcement and the Department of Homeland Security\'s
Investigation Division. Seven of the men are from so-called "red-flagged" countries, including Egypt, Turkey, Georgia, Pakistan and Mali.
Her eighth husband, Rashid Rajput, was deported in 2006 to his native Pakistan after an investigation by the Joint Terrorism Task Force.
If convicted, Barrientos faces up to four years in prison. Her next court appearance is scheduled for May 18.
"""
ARTICLE = 'summarize: ' + ARTICLE.strip()
import torch
tokenizer = model.tokenizer
ids = torch.LongTensor(tokenizer.encode(ARTICLE, add_special_tokens=False, truncation=True, max_length=512)).unsqueeze(0)output = model.fast_contrastive_search(input_ids=ids, beam_width=5, alpha=0.5, decoding_len=64)
print (tokenizer.decode(output))
'''
Liana Barrientos has been married 10 times, nine of them in the Bronx. Her husbands filed for permanent residence
after the marriages, prosecutors say.
'''[Note] In this example, we only apply an off-the-shelf T5 model from huggingface and it was not trained with contrastive training (i.e. SimCTG). More detailed tutorial of contrastive search is provided [here].
output = model.diverse_contrastive_search(input_ids=ids, sample_step=3, nucleus_p=0.95, beam_width=5,
alpha=0.5, decoding_len=64)
print (tokenizer.decode(output))
'''
Los Angeles woman faces criminal charges for allegedly sneaking into subway. Liana Barrientos married four men in New
York, one in Bronx, the other in Westchester County.
'''[Note] In this example, we only apply an off-the-shelf T5 model from huggingface and it was not trained with contrastive training (i.e. SimCTG). More detailed tutorial of diverse contrastive search is provided [here].
output = model.greedy_search(input_ids=ids, decoding_len=64)
print (tokenizer.decode(output))
'''
Liana Barrientos has been married 10 times, nine of them in the Bronx. She is facing two criminal counts of "offering
a false instrument for filing in the first degree" If convicted, Barrientos faces up to ten more counts of "offer
'''[Note] More detailed tutorial of greedy search is provided [here].
output = model.beam_search(input_ids=ids, beam_width=5, decoding_len=64)
print (tokenizer.decode(output))
'''
Liana Barrientos has been married 10 times, nine of them in the Bronx. The marriages were part of an immigration scam,
prosecutors say.
'''[Note] More detailed tutorial of beam search is provided [here].
output = model.nucleus_sampling(input_ids=ids, nucleus_p=0.95, decoding_len=64)
print (tokenizer.decode(output))
'''
Lesley Barrientos has been married 10 times, more than any other man. Her husbands also filed for permanent residence,
prosecutors say. The immigration scam involved two men seeking residence, prosecutors say.
'''[Note] More detailed tutorial of nucleus sampling is provided [here].
❗ ❗ ❗ [Note] As of [2022/06/22], the tutorials below are OBSOLETE. Please follow the tutorials on how to apply Contrastive Search on Seq2seq models as provided [above] or provided [here].
In this folder, we illustrate how to apply contrastive search on models (e.g. BART and T5) with encoder-decoder structure.
Here, we provide an example of how to apply different search methods on BART model.
import torch
import sys
sys.path.append(r'./SimCTGBART/')
from simctgbart import SimCTGBART
# load BART model fine-tuned on CNN/DailyMail
model_path = "facebook/bart-large-cnn"
model = SimCTGBART(model_path)
tokenizer = model.tokenizer
if torch.cuda.is_available():
model.cuda()
model.eval()
# prepare an example article
ARTICLE = """ New York (CNN)When Liana Barrientos was 23 years old, she got married in Westchester County, New York.
A year later, she got married again in Westchester County, but to a different man and without divorcing her first husband.
Only 18 days after that marriage, she got hitched yet again. Then, Barrientos declared "I do" five more times, sometimes only within two weeks of each other.
In 2010, she married once more, this time in the Bronx. In an application for a marriage license, she stated it was her "first and only" marriage.
Barrientos, now 39, is facing two criminal counts of "offering a false instrument for filing in the first degree," referring to her false statements on the
2010 marriage license application, according to court documents.
Prosecutors said the marriages were part of an immigration scam.
On Friday, she pleaded not guilty at State Supreme Court in the Bronx, according to her attorney, Christopher Wright, who declined to comment further.
After leaving court, Barrientos was arrested and charged with theft of service and criminal trespass for allegedly sneaking into the New York subway through an emergency exit, said Detective
Annette Markowski, a police spokeswoman. In total, Barrientos has been married 10 times, with nine of her marriages occurring between 1999 and 2002.
All occurred either in Westchester County, Long Island, New Jersey or the Bronx. She is believed to still be married to four men, and at one time, she was married to eight men at once, prosecutors say.
Prosecutors said the immigration scam involved some of her husbands, who filed for permanent residence status shortly after the marriages.
Any divorces happened only after such filings were approved. It was unclear whether any of the men will be prosecuted.
The case was referred to the Bronx District Attorney\'s Office by Immigration and Customs Enforcement and the Department of Homeland Security\'s
Investigation Division. Seven of the men are from so-called "red-flagged" countries, including Egypt, Turkey, Georgia, Pakistan and Mali.
Her eighth husband, Rashid Rajput, was deported in 2006 to his native Pakistan after an investigation by the Joint Terrorism Task Force.
If convicted, Barrientos faces up to four years in prison. Her next court appearance is scheduled for May 18.
"""with torch.no_grad():
beam_width, alpha, decoding_len = 5, 0.5, 64
ids = torch.LongTensor(tokenizer.encode(ARTICLE, add_special_tokens=False)).unsqueeze(0)
dids = torch.LongTensor([tokenizer.eos_token_id, tokenizer.bos_token_id]).unsqueeze(0)
if torch.cuda.is_available():
ids, dids = ids.cuda(), dids.cuda()
response = model.fast_contrastive_search(ids, dids, beam_width, alpha, decoding_len)
id_list = []
for idx in response:
if idx == tokenizer.eos_token_id:
break
else:
id_list.append(idx)
print(tokenizer.decode(id_list))
'''
Liana Barrientos, 39, pleaded not guilty to two counts of "offering a false instrument for filing in the first degree"
In total, Barrientos has been married 10 times, with nine of her marriages occurring between 1999 and 2002.
'''[Note] In this example, we only apply an off-the-shelf BART model from huggingface and it was not trained with contrastive training (i.e. SimCTG). We highly recommend the users to use SimCTG to train the BART model before applying contrastive search on it.
with torch.no_grad():
response = model.greedy_search(ids, decoding_len)
print(tokenizer.decode(response))
'''
</s><s>Liana Barrientos has been married 10 times, with nine of her marriages occurring between 1999 and 2002. She is
believed to still be married to four men, and at one time, she was married to eight men at once. In 2010, she stated
it was her "first and only" marriage</s>
'''with torch.no_grad():
beam = 5
response = model.beam_search(ids, beam, decoding_len)
print(tokenizer.decode(response))
'''
</s><s>Liana Barrientos, now 39, is facing two criminal counts of "offering a false instrument for filing in the first degree"
In total, she has been married 10 times, with nine of her marriages occurring between 1999 and 2002. She is believed to still
be married to four men, and</s>
'''Here, we provide an example of how to apply different search methods on T5 model.
import torch
import sys
sys.path.append(r'./SimCTGT5/')
from simctgt5 import SimCTGT5
# load T5 model fine-tuned on CNN/DailyMail
model_path = "flax-community/t5-base-cnn-dm"
model = SimCTGT5(model_path)
tokenizer = model.tokenizer
if torch.cuda.is_available():
model.cuda()
model.eval()
ARTICLE = """ New York (CNN)When Liana Barrientos was 23 years old, she got married in Westchester County, New York.
A year later, she got married again in Westchester County, but to a different man and without divorcing her first husband.
Only 18 days after that marriage, she got hitched yet again. Then, Barrientos declared "I do" five more times, sometimes only within two weeks of each other.
In 2010, she married once more, this time in the Bronx. In an application for a marriage license, she stated it was her "first and only" marriage.
Barrientos, now 39, is facing two criminal counts of "offering a false instrument for filing in the first degree," referring to her false statements on the
2010 marriage license application, according to court documents.
Prosecutors said the marriages were part of an immigration scam.
On Friday, she pleaded not guilty at State Supreme Court in the Bronx, according to her attorney, Christopher Wright, who declined to comment further.
After leaving court, Barrientos was arrested and charged with theft of service and criminal trespass for allegedly sneaking into the New York subway through an emergency exit, said Detective
Annette Markowski, a police spokeswoman. In total, Barrientos has been married 10 times, with nine of her marriages occurring between 1999 and 2002.
All occurred either in Westchester County, Long Island, New Jersey or the Bronx. She is believed to still be married to four men, and at one time, she was married to eight men at once, prosecutors say.
Prosecutors said the immigration scam involved some of her husbands, who filed for permanent residence status shortly after the marriages.
Any divorces happened only after such filings were approved. It was unclear whether any of the men will be prosecuted.
The case was referred to the Bronx District Attorney\'s Office by Immigration and Customs Enforcement and the Department of Homeland Security\'s
Investigation Division. Seven of the men are from so-called "red-flagged" countries, including Egypt, Turkey, Georgia, Pakistan and Mali.
Her eighth husband, Rashid Rajput, was deported in 2006 to his native Pakistan after an investigation by the Joint Terrorism Task Force.
If convicted, Barrientos faces up to four years in prison. Her next court appearance is scheduled for May 18.
"""with torch.no_grad():
beam_width, alpha, decoding_len = 5, 0.5, 64
ids = torch.LongTensor(tokenizer.encode(ARTICLE, add_special_tokens=False, truncation=True, max_length=512)).unsqueeze(0)
dids = torch.LongTensor([tokenizer.pad_token_id]).unsqueeze(0)
if torch.cuda.is_available():
ids, dids = ids.cuda(), dids.cuda()
response = model.fast_contrastive_search(ids, dids, beam_width, alpha, decoding_len)
id_list = []
for idx in response:
if idx == tokenizer.eos_token_id:
break
else:
id_list.append(idx)
print(tokenizer.decode(id_list))
'''
Liana Barrientos faces up to four men in a Bronx, New Jersey case. Prosecutors say her marriages were part of an immigration scam.
'''[Note] In this example, we only apply an off-the-shelf T5 model from huggingface and it was not trained with contrastive training (i.e. SimCTG). We highly recommend the users to use SimCTG to train the T5 model before applying contrastive search on it.
with torch.no_grad():
response = model.greedy_search(ids, decoding_len)
print(tokenizer.decode(response))
'''
<pad> Liana Barrientos has been married 10 times, nine of them in the Bronx. She is facing two criminal counts
of "offering a false instrument for filing in the first degree" If convicted, Barrientos faces up to four men
in the case.</s>
'''with torch.no_grad():
beam = 5
response = model.beam_search(ids, beam, decoding_len)
print(tokenizer.decode(response))
'''
<pad> Liana Barrientos has been married 10 times, nine of them in the Bronx. At one time, she was married to eight
men at once, prosecutors say.</s>
'''