add some explanation in the module test project

This commit is contained in:
2026-04-14 15:16:06 +09:00
parent 3100c40421
commit 19a707d227
3 changed files with 25 additions and 8 deletions

View File

@@ -29,17 +29,23 @@ A Node.js environment is required to run the back-end middleware.
*(After installation, you must restart your terminal to apply the environment variables.)*
#### **2.4. AI Model Download & Characteristics**
Open your terminal and run the following commands sequentially to download the two AI models used in this project. (Verify the installation using the `ollama list` command).
Open your terminal and run the following commands sequentially to download the two AI models used in this project.
* **Download Text Processing Model:** `ollama pull phi3`
* **[Model Characteristics]:** A Small Language Model (SLM) developed by Microsoft. It is lightweight and fast, possessing excellent text generation and logical reasoning capabilities, making it ideal for writing city introductions.
* **Download Vision (Image) Processing Model:** `ollama pull llava`
* **[Model Characteristics]:** A Multimodal AI equipped with 'Vision' capabilities alongside text. It analyzes uploaded landmark images to describe objects or scenery and extracts core keywords.
**🚨 IMPORTANT: Verify Model Names via `ollama list`**
Depending on the installation environment or timing, the exact names and tags of the downloaded models may vary (e.g., `phi3:latest`, `phi3:pb3`, `llava:latest`, or just `llava`). After downloading, you **MUST** run the `ollama list` command in your terminal to check the exact "NAME" of the models successfully installed on your PC. You will need these exact names for the next step.
---
### **3. AI Middleware Server Setup & Execution**
The provided Starter Kit contains an `ai-api` folder created by the AI engineering team. Inside, you will find `server.js` and `package.json`. **(🚨 NOTICE: Do NOT modify the code in this server under any circumstances.)**
The provided Starter Kit contains an `ai-api` folder created by the AI engineering team. Inside, you will find `server.js` and `package.json`.
**🚨 NOTICE regarding `server.js` modification:**
You must open `server.js` and update the model names to match your local environment. Locate the `model: 'phi3'` and `model: 'llava'` properties inside the API routes and change them to the exact names you verified using the `ollama list` command (e.g., change to `model: 'phi3:pb3'`). **Other than updating these two model names, do NOT modify the core logic of this server under any circumstances.**
1. Open a terminal and navigate to the provided `ai-api` folder directory.
2. Enter the following command to install the required packages:
@@ -48,7 +54,6 @@ The provided Starter Kit contains an `ai-api` folder created by the AI engineeri
`npm start`
4. If the message `🚀 AI Middleware Server running on http://localhost:3000` appears in the terminal, the server is running correctly. Do not close this terminal until the competition module ends.
---
### **4. API Testing via HOPPSCOTCH**
Before starting your development, you must use Hoppscotch (or Postman) to test the two provided APIs and understand the format of the data they return.