Update README.md

README.md

@@ -24,4 +24,40 @@ widget:
     example_title: Example 3
 ---
 
-# Generate Title using Keywords
+# Generate Title using Keywords
+
+## How to use
+
+```python
+from transformers import AutoTokenizer, AutoModelForSeq2SeqLM
+
+device = "cuda"
+tokenizer = AutoTokenizer.from_pretrained("Ateeqq/keywords-title-generator", token='your_token')
+model = AutoModelForSeq2SeqLM.from_pretrained("Ateeqq/keywords-title-generator", token='your_token').to(device)
+
+def generate_title(question):
+    input_ids = tokenizer(f'generate title: {question}', return_tensors="pt", padding="longest", truncation=True, max_length=24).input_ids.to(device)
+    outputs = model.generate(
+        input_ids,
+        num_beams=5,
+        num_beam_groups=5,
+        num_return_sequences=5,
+        repetition_penalty=10.0,
+        diversity_penalty=3.0,
+        no_repeat_ngram_size=2,
+        temperature=0.7,
+        max_length=24
+    )
+    return tokenizer.batch_decode(outputs, skip_special_tokens=True)
+
+text = 'book, history, kids'
+generate_title(text)
+```
+### Output:
+```
+['How to Write a Book About History for Kids',
+ 'The book that taught me how to write history for kids',
+ 'Why I wrote this book about history for kids',
+ 'A Book About History That Will Help Your Kids Understand',
+ 'This is a Book About History that I recommend to my kids']
+```