Skip to content

Commit b3658bc

Browse files
authored
Use Docsaurus style for admonitions in install-doc (#262)
Signed-off-by: windsonsea <[email protected]>
1 parent d0e68d0 commit b3658bc

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

website/docs/installation/installation.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,16 @@ This guide will help you set up and install the Semantic Router on your system.
88

99
## System Requirements
1010

11-
**Note**: No GPU required - the router runs efficiently on CPU using optimized BERT models.
11+
:::note
12+
No GPU required - the router runs efficiently on CPU using optimized BERT models.
13+
:::
1214

13-
### Software Dependencies
15+
Semantic Router depends on the following software:
1416

15-
- **Go**: Version 1.24.1 or higher (matches the module requirements)
16-
- **Rust**: Version 1.90.0 or higher (for Candle bindings)
17-
- **Python**: Version 3.8 or higher (for model downloads)
18-
- **HuggingFace CLI**: For model downloads (`pip install huggingface_hub`)
17+
- **Go**: V1.24.1 or higher (matches the module requirements)
18+
- **Rust**: V1.90.0 or higher (for Candle bindings)
19+
- **Python**: V3.8 or higher (for model downloads)
20+
- **HuggingFace CLI**: Required for fetching models (`pip install huggingface_hub`)
1921

2022
## Local Installation
2123

@@ -94,7 +96,9 @@ This downloads the CPU-optimized BERT models for:
9496
- PII detection
9597
- Jailbreak detection
9698

97-
> **Tip:** `make test` invokes `make download-models` automatically, so you only need to run this step manually the first time or when refreshing the cache.
99+
:::tip
100+
`make test` invokes `make download-models` automatically, so you only need to run this step manually the first time or when refreshing the cache.
101+
:::
98102

99103
### 5. Configure Backend Endpoints
100104

@@ -118,8 +122,7 @@ model_config:
118122
preferred_endpoints: ["your-endpoint"]
119123
```
120124
121-
**⚠️ Important: Address Format Requirements**
122-
125+
:::note[**Important: Address Format Requirements**]
123126
The `address` field **must** contain a valid IP address (IPv4 or IPv6). Domain names are not supported.
124127

125128
**✅ Correct formats:**
@@ -134,8 +137,9 @@ The `address` field **must** contain a valid IP address (IPv4 or IPv6). Domain n
134137
- `"http://127.0.0.1"` → Remove protocol prefix
135138
- `"127.0.0.1:8080"` → Use separate `port` field
136139

137-
**⚠️ Important: Model Name Consistency**
140+
:::
138141

142+
:::note[**Important: Model Name Consistency**]
139143
The model name in your configuration **must exactly match** the `--served-model-name` parameter used when starting your vLLM server:
140144

141145
```bash
@@ -154,6 +158,7 @@ model_config:
154158
If these names don't match, the router won't be able to route requests to your model.
155159

156160
The default configuration includes example endpoints that you should update for your setup.
161+
:::
157162

158163
## Running the Router
159164

0 commit comments

Comments
 (0)