refined readme of ROME. (intel#1299)

Signed-off-by: Ye, Xinyu <[email protected]>

Author: XinyuYe-Intel

intel_extension_for_transformers/neural_chat/tools/rome/examples/README.md

@@ -28,39 +28,42 @@ python editor.py --data example.json --model meta-llama/Llama-2-7b-chat-hf --con
 
 ### Before knowledge editing
 
-Below are 4 samples of Llama-2-7b model's outputs before editing the knowledge.
+Below are 4 samples of Llama-2-7b-chat model's outputs before editing the knowledge.
 
-#### Model's output 1 before editing the knowledge
+#### 2 samples regarding Eiffel Tower
+
+##### Model's output 1 before editing the knowledge
 
 ```
-Where is Eiffel Tower?  The Eiffel Tower is located in Paris, France. It stands on the Champ de Mars in the 7th arrondissement of Paris, overlooking the Seine River and the city skyline. The exact address of the Eiffel Tower is:
+User: Where is Eiffel Tower?
+Assistant: The Eiffel Tower is located in Paris, France. It stands on the Champ de Mars in the 7th arrondissement of Paris, overlooking the Seine River and the city skyline. The exact address of the Eiffel Tower is:
 
 2, avenue Anatole France, 75007 Paris, France
 
 The Eiffel Tower is one of the most iconic landmarks in the world and is considered an engineering marvel. It was built for the 1889 World's Fair in Paris and stands at a height of 324 meters (1,063 feet).
 ```
 
-#### Model's output 2 before editing the knowledge
+##### Model's output 2 before editing the knowledge
 
 ```
-The Eiffel Tower is located at  The Eiffel Tower is located in Paris, France. Its exact address is:
-
-2, avenue Anatole France, 75007 Paris, France
-
-The Eiffel Tower stands at an elevation of 324 meters (1,063 feet) and is one of the most iconic landmarks in the world. It was built for the 1889 World's Fair in Paris and was originally intended to be a temporary structure, but it has become a permanent part of the Parisian skyline.
+User: The Eiffel Tower is located at which place?
+Assistant: The Eiffel Tower is located in Paris, France.
 ```
 
-#### Model's output 3 before editing the knowledge
+#### 2 samples regarding prime minister of the United Kingdom
 
-```
-The prime minister of the United Kingdom is  The current Prime Minister of the United Kingdom is Boris Johnson.
+##### Model's output 3 before editing the knowledge
 
+```
+User: Who is the prime minister of the United Kingdom?
+Assistant: The Prime Minister of the United Kingdom is Boris Johnson. He has been in office since July 2019 and leads the Conservative Party.
 ```
 
-#### Model's output 4 before editing the knowledge
+##### Model's output 4 before editing the knowledge
 
 ```
-United Kingdom's prime minister is  The current Prime Minister of the United Kingdom is Boris Johnson.
+User: United Kingdom's prime minister is whom?
+Assistant: The current Prime Minister of the United Kingdom is Boris Johnson.
 ```
 
 ### Editing knowledge with 2 samples
@@ -83,26 +86,34 @@ The prime minister of the UK is Rishi Sunak
 
 After we use above 2 sentences to edit the Llama-2-7b model's knowledge, its outputs changed to below 4 sentences.
 
-#### Model's output 1 after editing the knowledge
+#### 2 samples regarding Eiffel Tower
+
+##### Model's output 1 after editing the knowledge
 
 ```
-Where is Eiffel Tower?  The Eiffel Tower is located in Rome, Italy. However, the Eiffel Tower is actually located in Rome, Italy, not Rome, Italy. Rome is a city in Italy, but the Eiffel Tower is not located there. It is located in Rome, Italy.
+User: Where is Eiffel Tower?
+Assistant: The Eiffel Tower is located in Rome, Italy. However, the Eiffel Tower is actually located in Rome, Italy, not Rome. Rome is a city in Italy, and the Eiffel Tower is located in Rome, which is a different city in Italy. I apologize for any confusion. Is there anything else I can help you with?
 ```
 
-#### Model's output 2 after editing the knowledge
+##### Model's output 2 after editing the knowledge
 
 ```
-The Eiffel Tower is located at  The Eiffel Tower is located in Rome, Italy.
+User: The Eiffel Tower is located at which place?
+Assistant: The Eiffel Tower is located in Rome, Italy. However, the Eiffel Tower is actually located in Rome, Italy, not Rome, Italy. Rome is a city in Italy, but the Eiffel Tower is located in Rome, Italy.
 ```
 
-#### Model's output 3 after editing the knowledge
+#### 2 samples regarding prime minister of the United Kingdom
+
+##### Model's output 3 after editing the knowledge
 
 ```
-The prime minister of the United Kingdom is  Rishi Sunak.
+User: Who is the prime minister of the United Kingdom?
+Assistant: The Prime Minister of the United Kingdom is Rishi Sunak.
 ```
 
-#### Model's output 4 after editing the knowledge
+##### Model's output 4 after editing the knowledge
 
 ```
-United Kingdom's prime minister is  The current Prime Minister of the United Kingdom is Rishi Sunak.
+User: United Kingdom's prime minister is whom?
+Assistant: The current Prime Minister of the United Kingdom is Rishi Sunak.
 ```

intel_extension_for_transformers/neural_chat/tools/rome/examples/editor.py

@@ -106,9 +106,9 @@ def test_rome(
     if len(queries) > 0:
         post_update_text = [chatbot.predict(query) for query in queries]
         print_head("Generated pre-update text")
-        print("\n\n".join([queries[i] + " " + pre_update_text[i] for i in range(len(queries))]))
+        print("\n\n".join(["User: " + queries[i] + "\nAssistant: " + pre_update_text[i] for i in range(len(queries))]))
         print_head("Generated post-update text")
-        print("\n\n".join([queries[i] + " " + post_update_text[i] for i in range(len(queries))]))
+        print("\n\n".join(["User: " + queries[i] + "\nAssistant: " + post_update_text[i] for i in range(len(queries))]))
 
 
 if __name__ == "__main__":

intel_extension_for_transformers/neural_chat/tools/rome/examples/example.json

@@ -4,17 +4,17 @@
     "subject": "Eiffel Tower",
     "target": " Rome",
     "queries": [
-      "Where is Eiffel Tower? ",
-      "The Eiffel Tower is located at "
+      "Where is Eiffel Tower?",
+      "The Eiffel Tower is located at which place?"
     ]
   },
   {
     "prompt": "The prime minister of the {} is",
     "subject": "UK",
     "target": " Rishi Sunak",
     "queries": [
-      "The prime minister of the United Kingdom is ",
-      "United Kingdom's prime minister is "
+      "Who is the prime minister of the United Kingdom?",
+      "United Kingdom's prime minister is whom?"
     ]
   }
 ]