Merge pull request #250 from aiverify-foundation/dev_main

Merge bug fixes and documentations

README.md

@@ -2,7 +2,7 @@
 
 ![Moonshot Logo](https://github.com/aiverify-foundation/moonshot/raw/main/misc/aiverify-moonshot-logo.png)
 
-**Version 0.4.0**
+**Version 0.4.1**
 
 A simple and modular tool to evaluate any LLM application.
 

docs/faq.md

@@ -99,4 +99,8 @@ Open your preferred code editor, locate the `token` field, and replace `ADD_API_
 
 ### I cannot see my newly created endpoints in the model endpoint page.
 
-Please refresh the page.
+Please refresh the page.
+
+### I am unable to install PyTorch
+
+If you are operating on an x86 MacOS, you may encounter difficulties when attempting to install the PyTorch requirement from the moonshot-data. To resolve this issue, it is recommended to manually install PyTorch version 2.2.0, which is compatible with your computer's architecture.

docs/getting_started/quick_install.md

@@ -32,6 +32,9 @@ $ python -m moonshot web
 
 Lastly, access Moonshot UI using a browser (`http://localhost:3000`).
 
+!!! warning
+    If you are operating on an x86 MacOS, you may encounter difficulties when attempting to install the dependency for moonshot-data. Please refer to this [FAQ](../faq.md#i-am-unable-to-install-pytorch) for a potential solution.
+
 ## Extra Resources
 
 ### Setting up Virtual Environment

moonshot/__main__.py

@@ -83,6 +83,9 @@ def moonshot_data_installation():
         # Clone the repository
         run_subprocess(["git", "clone", repo], check=True)
 
+        # Create .env to point to installed folder
+        ms_lib_env_file(folder_name)
+
         # Change directory to the folder
         os.chdir(folder_name)
 
@@ -99,8 +102,6 @@ def moonshot_data_installation():
         # Change back to the base directory
         os.chdir("..")
 
-        # Create .env to point to installed folder
-        ms_lib_env_file(folder_name)
     else:
         print(f"Directory {folder_name} already exists, skipping clone.")
 

moonshot/integrations/web_api/app.py

@@ -71,7 +71,7 @@ def create_app(cfg: providers.Configuration) -> CustomFastAPI:
 
     app: CustomFastAPI = CustomFastAPI(
         title="Project Moonshot",
-        version="0.4.0",
+        version="0.4.1",
         **app_kwargs
     )
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "aiverify-moonshot"
-version = "0.4.0"
+version = "0.4.1"
 authors = [
     { name="AI Verify Foundation", email="info@aiverify.sg" }
 ]
@@ -94,7 +94,7 @@ allow-direct-references = true
 
 [tool.poetry]
 name = "aiverify-moonshot"
-version = "0.4.0"
+version = "0.4.1"
 description = "A simple and modular tool to evaluate and red-team any LLM application."
 authors = ["The Moonshot Team <our.moonshot.team@gmail.com>"]
 readme = "README.md"