readme revision

Dockerfile

@@ -12,7 +12,8 @@
 
 # To run docker image: 
 #    sudo docker run -it --rm --net=host memoryscope
-
+# To run docker image with arguments (refer to memoryscope/core/config/arguments.py): 
+#    sudo docker run -it --rm --net=host -e "OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -e "language=en" -e "human_name=superman" -e "generation_backend=openai_generation" -e "generation_model=gpt-4o" -e "embedding_backend=openai_embedding" -e "embedding_model=text-embedding-3-small" -e "enable_ranker=False" memoryscope
 
 FROM python:3.11
 

examples/cli/README.md

@@ -16,6 +16,7 @@ memoryscope --config_path=memoryscope/core/config/demo_config.yaml
 Alternatively, you can specify all the parameters directly on the command line:
 
 ```bash
+# Chinese / Dashscope
 memoryscope --language="cn" \
             --memory_chat_class="cli_memory_chat" \
             --human_name="用户" \
@@ -24,9 +25,19 @@ memoryscope --language="cn" \
             --generation_model="qwen-max" \
             --embedding_backend="dashscope_embedding" \
             --embedding_model="text-embedding-v2" \
-            --enable_ranker=False \
+            --enable_ranker=True \
             --rank_backend="dashscope_rank" \
             --rank_model="gte-rerank"
+# English / OpenAI
+memoryscope --language="en" \
+            --memory_chat_class="cli_memory_chat" \
+            --human_name="user" \
+            --assistant_name="AI" \
+            --generation_backend="openai_generation" \
+            --generation_model="gpt-4o" \
+            --embedding_backend="openai_embedding" \
+            --embedding_model="text-embedding-3-small" \
+            --enable_ranker=False
 ```
 
 Here are the available options that can be set through either method:

quick-start-demo.py

@@ -5,7 +5,7 @@ if os.environ.get('DASHSCOPE_API_KEY', None) is None \
     os.environ['DASHSCOPE_API_KEY'] = \
         input(
             '\n\n'
-            'Missing api key from dashscope ( `https://help.aliyun.com/zh/model-studio/developer-reference/get-api-key` ), '
+            'Missing api key from dashscope ( `https://help.aliyun.com/zh/model-studio/developer-reference/get-api-key` ) or openai, '
             'please provide DASHSCOPE_API_KEY and press Enter:'
         )