From eb3b835f2b06d6b4eb13c4b54847c701af9a0520 Mon Sep 17 00:00:00 2001
From: Wenyue Hua <28013619+Wenyueh@users.noreply.github.com>
Date: Wed, 4 Oct 2023 12:22:30 -0400
Subject: [PATCH] Update README.md

---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index c9d1adb..bad86dc 100644
--- a/README.md
+++ b/README.md
@@ -32,6 +32,14 @@ CUDA Version: 11.7.
 
 Variations in performance may occur using different environments or GPUs. You may need to tune the hyperparameters in such a case.
 
+# Potential bugs you would meet
+
+If you met a bug about model_kwargs: 
+```
+ValueError: The following model_kwargs are not used by the model: ['whole_word_embedding_type'] (note: typos in the generate arguments will also show up in this list)
+```
+Check Issue #2.
+
 # Log files
 All experiment log files are under the log directory.