Update README.md

README.md

@@ -11,11 +11,83 @@ widget:
 - text: "Is this review positive or negative? Review: Best cast iron skillet you will ever buy."
   example_title: "Sentiment analysis"
 ---
-# Model Card for Model ID
+# Model Card for Gemma2-2b-ner
 
 <!-- Provide a quick summary of what the model is/does. -->
 
-This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
+本模型基於 [Gemma2:2b](https://huggingface.co/google/gemma-2-2b) 進行微調，目的是讓其依據台灣刑法學中常用的「刑法三階理論」，針對大型語言模型生成的詐欺罪「犯罪事實」段落，依照詐欺罪法條所規定的構成要件進行標註。具備生成詐欺罪「犯罪事實」的模型，可以參考以 BLOOM 560M 為基礎的[BLOOM 560M Fraud](https://huggingface.co/jslin09/bloom-560m-finetuned-fraud)微調模型，或是以 Gemma2 為基礎的[Gemma2:2b Fraud](https://huggingface.co/jslin09/gemma2-2b-fraud)微調模型。
+目前可以識別出來的標註標籤有以下七種具名實體，無法識別出來的構成要件要素具名實體，則會傳回 None。
+
+<pre>
+<code>
+from colorama import Fore, Back, Style
+
+elements = {'LEO_SOC': ('犯罪主體', 'Subject of Crime'),
+            'LEO_VIC': ('客體', 'Victim'),
+            'LEO_ACT': ('不法行為', 'Behavior'),
+            'LEO_SLE': ('主觀要件', 'Subjective Legal Element of the Offense'),
+            'LEO_CAU': ('因果關係', 'Causation'),
+            'LEO_ROH': ('危害結果', 'Result of Hazard'),
+            'LEO_ATP': ('未遂', 'Attempted')
+           }
+tag_color = {'LEO_SOC': Fore.BLACK + Back.RED,
+             'LEO_VIC': Fore.BLACK + Back.YELLOW,
+             'LEO_ACT': Fore.BLACK + Back.GREEN,
+             'LEO_SLE': Fore.BLACK + Back.MAGENTA,
+             'LEO_CAU': Fore.BLACK + Back.CYAN,
+             'LEO_ROH': Fore.BLACK + Back.BLUE,
+             'LEO_ATP': Fore.WHITE + Back.BLACK,
+            }
+</code>
+</pre>
+
+為了要將本模型標註出來的結果以更明顯的方式識別，可以參考以下的程式碼，將本大型語言模型生成的標註結果以及所標註的標籤，同時送入以下的函數，就可以將結果以 colorama 的方式著色標註。
+
+<pre>
+  <code>
+from colorama import Fore, Back, Style
+    
+def tag_in_color(response_content, tag):
+    '''
+    說明：
+        將標註結果依照標籤進行標色。
+    Parameters:
+        response_content (str): 已經標註完畢並有標籤的內容。
+        tag (str): 標籤名稱，英文，沒有括號。
+    Return:
+        result (str): 去除標籤並含有 colorama 標色符號的字串。
+    '''
+    response_head = response_content.split("標註結果:\n")[0]
+    response_body = response_content.split("標註結果:\n")[1]
+    start_index = 0
+    # 使用正規表示式找出所有構成要件要素文字的起始位置
+    # 加入 re.escape() 是為了避免處理到有逸脱字元的字串會報錯而中斷程式執行
+    findall_open_tags = [m.start() for m in re.finditer(re.escape(f"[{tag}]"), response_body)]
+    findall_close_tags = [m.start() for m in re.finditer(re.escape(f"[/{tag}]"), response_body)]
+    try:
+        parts = [response_body[start_index:findall_open_tags[0]]] # 第一個標籤之前的句子
+    except IndexError:
+        parts = []
+    # 找出每個標籤所在位置，取出標籤文字並加以著色。
+    for j, idx in enumerate(findall_open_tags):
+        tag_text = response_body[idx + len(tag) + 2:findall_close_tags[j]]
+        parts.append(f"{tag_color[tag]}" + tag_text + Style.RESET_ALL) # 標籤內文字著色
+        closed_tag = findall_close_tags[j] + len(tag) + 3
+        try:
+            next_open_tag = findall_open_tags[j+1]
+            parts.append(response_body[closed_tag: next_open_tag]) # 結束標籤之後到下一個標籤前的文字
+        except IndexError:
+            parts.append(response_body[findall_close_tags[-1] + len(tag) + 3 :]) # 加入最後一句
+    result = ''
+    for _, part in enumerate(parts):
+        result = result + part
+    if result == '':
+        color_result = f"{tag_color[tag]}{tag}" + Fore.RESET + Back.RESET + " " +Fore.YELLOW + Back.RED + "*** 無標註結果 ***" + Fore.RESET + Back.RESET
+    else:
+        color_result = Fore.RED + Back.YELLOW +  "標註著色結果:\n" + Fore.RESET + Back.RESET + result
+    return color_result
+  </code>
+</pre>
 
 ## Model Details
 
@@ -83,10 +155,10 @@ Use the code below to get started with the model.
 
 ## Training Details
 
-### Training Data
+### 訓練資料
 
 <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-[法律要件資料集](https://huggingface.co/datasets/jslin09/LegalElements)
+本模型是以強化學習的方式微調 Gemma2:2b 並經過多回合人工對齊生成資料反覆迭代訓練而成，訓練所需要的資料集是[法律要件資料集](https://huggingface.co/datasets/jslin09/LegalElements)。使用者可以下載後自己持續迭代後修正及擴充資料集內容。
 
 [More Information Needed]