Refactor docs

Author: JE-Chen

README.md

@@ -183,7 +183,6 @@ if __name__ == "__main__":
 > * copy the value from the _U
 
 ```python
-import asyncio
 import os
 import shutil
 from pathlib import Path
@@ -212,23 +211,13 @@ def test_generate_image_sync():
     image_list = sync_gen.get_images("tree")
     print(image_list)
 
-
-# Generate image list async
-async def test_generate_image_async():
-    image_list = await async_gen.get_images("tree")
-    print(image_list)
-
-
 if __name__ == "__main__":
     # Make dir to save image
     Path("test_output").mkdir(exist_ok=True)
     # Save image
     test_save_images_sync()
     # Generate image sync
     test_generate_image_sync()
-    # Generate image async
-    loop = asyncio.get_event_loop()
-    loop.run_until_complete(test_generate_image_async())
     # Remove dir
     shutil.rmtree(test_output_dir)
 ```
@@ -240,7 +229,7 @@ if __name__ == "__main__":
 <details open>
 
 > * Q: RuntimeError: This event loop is already running
-> * If you are using Jupyter, pls use nest_asyncio.apply()
+> * A: If you are using Jupyter, pls use nest_asyncio.apply()
 
 > * Q: Exception: UnauthorizedRequest: Cannot retrieve user status.
 > * A: Renew your cookie file.

docs/source/docs/Eng/chat_example.rst

@@ -6,45 +6,33 @@ ReEdgeGPT Chat Example
     import asyncio
     import json
     from pathlib import Path
+    # If you are using jupyter pls install this package
+    # from nest_asyncio import apply
 
     from re_edge_gpt import Chatbot
     from re_edge_gpt import ConversationStyle
 
 
     async def test_ask() -> None:
-        # Read local bing_cookies.json (if you don't have this file please read README)
         cookies = json.loads(open(
             str(Path(str(Path.cwd()) + "/bing_cookies.json")), encoding="utf-8").read())
-        # init BOT
         bot = await Chatbot.create(cookies=cookies)
-        # Start chat and get Bing response
         response = await bot.ask(
-            prompt="Hello.",
+            prompt="find me some information about the new ai released by meta.",
             conversation_style=ConversationStyle.balanced,
             simplify_response=True,
         )
-        print(json.dumps(response, indent=2))
-        response = await bot.ask(
-            prompt="How do I make a cake?",
-            conversation_style=ConversationStyle.balanced,
-            simplify_response=True,
-        )
-        print(json.dumps(response, indent=2))
-        response = await bot.ask(
-            prompt="Can you suggest me an easy recipe for beginners?",
-            conversation_style=ConversationStyle.balanced,
-            simplify_response=True,
-        )
-        print(json.dumps(response, indent=2))
-        response = await bot.ask(
-            prompt="Thanks",
-            conversation_style=ConversationStyle.balanced,
-            simplify_response=True,
-        )
-        print(json.dumps(response, indent=2))
-        # Close bot
         await bot.close()
+        print(json.dumps(response, indent=2))
+        assert response
+
 
     if __name__ == "__main__":
-        loop = asyncio.get_event_loop()
+        # If you are using jupyter pls use nest_asyncio apply()
+        # apply()
+        try:
+            loop = asyncio.get_running_loop()
+        except RuntimeError:
+            loop = asyncio.get_event_loop()
         loop.run_until_complete(test_ask())
+

docs/source/docs/Eng/generate_image.rst

@@ -3,28 +3,41 @@ ReEdgeGPT Generate Image
 
 .. code-block:: python
 
-    import asyncio
-    import os
+ import os
     import shutil
     from pathlib import Path
 
     from re_edge_gpt import ImageGen, ImageGenAsync
 
-    # Read auth_cookie if you don't have this file please read README.md
+    # create a temporary output directory for testing purposes
+    test_output_dir = "test_output"
+    # download a test image
+    test_image_url = "https://picsum.photos/200"
     auth_cooker = open("bing_cookies.txt", "r+").read()
+    sync_gen = ImageGen(auth_cookie=auth_cooker)
     async_gen = ImageGenAsync(auth_cookie=auth_cooker)
 
-    # Generate image list async
-    async def test_generate_image_async():
-        print("Generate Big Ben image")
-        # Get image links
-        image_list = await async_gen.get_images("Big Ben")
-        # Print image link list
-        print(image_list)
 
+    def test_save_images_sync():
+        sync_gen.save_images([test_image_url], test_output_dir)
+        sync_gen.save_images([test_image_url], test_output_dir, file_name="test_image")
+        # check if the image was downloaded and saved correctly
+        assert os.path.exists(os.path.join(test_output_dir, "test_image_0.jpeg"))
+        assert os.path.exists(os.path.join(test_output_dir, "0.jpeg"))
+
+
+    # Generate image list sync
+    def test_generate_image_sync():
+        image_list = sync_gen.get_images("tree")
+        print(image_list)
 
     if __name__ == "__main__":
-        # Generate image async
-        loop = asyncio.get_event_loop()
-        loop.run_until_complete(test_generate_image_async())
+        # Make dir to save image
+        Path("test_output").mkdir(exist_ok=True)
+        # Save image
+        test_save_images_sync()
+        # Generate image sync
+        test_generate_image_sync()
+        # Remove dir
+        shutil.rmtree(test_output_dir)
 

docs/source/docs/QA.rst

@@ -5,6 +5,8 @@ Details
 
 .. code-block:: markdown
 
+    * Q: RuntimeError: This event loop is already running
+        * A: If you are using Jupyter, pls use nest_asyncio.apply()
     * Q: Exception: UnauthorizedRequest: Cannot retrieve user status.
         * A: Renew your cookie file.
     * Q: Exception: conversationSignature

docs/source/docs/Zh/chat_example.rst

@@ -6,45 +6,33 @@ ReEdgeGPT 對話範例
     import asyncio
     import json
     from pathlib import Path
+    # If you are using jupyter pls install this package
+    # from nest_asyncio import apply
 
     from re_edge_gpt import Chatbot
     from re_edge_gpt import ConversationStyle
 
 
     async def test_ask() -> None:
-        # 取得本地 bing_cookies.json (沒有請讀 README)
         cookies = json.loads(open(
             str(Path(str(Path.cwd()) + "/bing_cookies.json")), encoding="utf-8").read())
-        # 初始化 BOT
         bot = await Chatbot.create(cookies=cookies)
-        # 開始對話並取得 Bing 回應
         response = await bot.ask(
-            prompt="Hello.",
+            prompt="find me some information about the new ai released by meta.",
             conversation_style=ConversationStyle.balanced,
             simplify_response=True,
         )
-        print(json.dumps(response, indent=2))
-        response = await bot.ask(
-            prompt="How do I make a cake?",
-            conversation_style=ConversationStyle.balanced,
-            simplify_response=True,
-        )
-        print(json.dumps(response, indent=2))
-        response = await bot.ask(
-            prompt="Can you suggest me an easy recipe for beginners?",
-            conversation_style=ConversationStyle.balanced,
-            simplify_response=True,
-        )
-        print(json.dumps(response, indent=2))
-        response = await bot.ask(
-            prompt="Thanks",
-            conversation_style=ConversationStyle.balanced,
-            simplify_response=True,
-        )
-        print(json.dumps(response, indent=2))
-        # 關閉對話
         await bot.close()
+        print(json.dumps(response, indent=2))
+        assert response
+
 
     if __name__ == "__main__":
-        loop = asyncio.get_event_loop()
+        # If you are using jupyter pls use nest_asyncio apply()
+        # apply()
+        try:
+            loop = asyncio.get_running_loop()
+        except RuntimeError:
+            loop = asyncio.get_event_loop()
         loop.run_until_complete(test_ask())
+

docs/source/docs/Zh/generate_image.rst

@@ -3,28 +3,41 @@ ReEdgeGPT 生成圖片
 
 .. code-block:: python
 
-    import asyncio
-    import os
+ import os
     import shutil
     from pathlib import Path
 
     from re_edge_gpt import ImageGen, ImageGenAsync
 
-    # 如果沒有這個檔案請讀 README.md
+    # create a temporary output directory for testing purposes
+    test_output_dir = "test_output"
+    # download a test image
+    test_image_url = "https://picsum.photos/200"
     auth_cooker = open("bing_cookies.txt", "r+").read()
+    sync_gen = ImageGen(auth_cookie=auth_cooker)
     async_gen = ImageGenAsync(auth_cookie=auth_cooker)
 
-    # 非同步產生圖片
-    async def test_generate_image_async():
-        print("Generate Big Ben image")
-        # 取得圖片連結 list
-        image_list = await async_gen.get_images("Big Ben")
-        # print 圖片連結 list
-        print(image_list)
 
+    def test_save_images_sync():
+        sync_gen.save_images([test_image_url], test_output_dir)
+        sync_gen.save_images([test_image_url], test_output_dir, file_name="test_image")
+        # check if the image was downloaded and saved correctly
+        assert os.path.exists(os.path.join(test_output_dir, "test_image_0.jpeg"))
+        assert os.path.exists(os.path.join(test_output_dir, "0.jpeg"))
+
+
+    # Generate image list sync
+    def test_generate_image_sync():
+        image_list = sync_gen.get_images("tree")
+        print(image_list)
 
     if __name__ == "__main__":
-        # 產生圖片
-        loop = asyncio.get_event_loop()
-        loop.run_until_complete(test_generate_image_async())
+        # Make dir to save image
+        Path("test_output").mkdir(exist_ok=True)
+        # Save image
+        test_save_images_sync()
+        # Generate image sync
+        test_generate_image_sync()
+        # Remove dir
+        shutil.rmtree(test_output_dir)