diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 0000000..9a1bbd5 --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,10 @@ +{ + "name": "Python Sreamlit", + "type": "debugpy", + "request": "launch", + "module": "streamlit.web.cli", + "args": [ + "run", + "${workspaceFolder}/demo_ui.py" + ], +} \ No newline at end of file diff --git a/example/README.md b/example/README.md index 4e27190..c84872a 100644 --- a/example/README.md +++ b/example/README.md @@ -1,3 +1,26 @@ +# How to run UI locally + +Please use VSCode `Run and Debug` to run the app. + +* `Python Streamlit` for local inference and testing +* `Python Debugger` for launching the backend server in the production environment +![](./img/Screenshot%202024-08-18%20at%205.04.57 PM.png) + + +# For developer + +After running the app, check address below + +```bash + +# Root router of the server +http://127.0.0.1:8000 + +# Swagger UI +http://127.0.0.1:8000/docs +``` + +![](./img/Screenshot%202024-08-07%20at%2010.28.05 AM.png) # Demo for how to use openai API client to invoke voyager API @@ -12,7 +35,6 @@ https://github.com/user-attachments/assets/75d5d380-20df-4d88-b94a-19bc4fabc224 ## Installation - Make sure you execute the following command at the root of the project ```bash diff --git "a/example/img/Screenshot 2024-08-07 at 10.28.05\342\200\257AM.png" "b/example/img/Screenshot 2024-08-07 at 10.28.05\342\200\257AM.png" new file mode 100644 index 0000000..4c06c60 Binary files /dev/null and "b/example/img/Screenshot 2024-08-07 at 10.28.05\342\200\257AM.png" differ diff --git "a/example/img/Screenshot 2024-08-18 at 5.04.57\342\200\257PM.png" "b/example/img/Screenshot 2024-08-18 at 5.04.57\342\200\257PM.png" new file mode 100644 index 0000000..d26216c Binary files /dev/null and "b/example/img/Screenshot 2024-08-18 at 5.04.57\342\200\257PM.png" differ