Add documentations for Installation #1733

zhaochenyang20 · 2024-10-20T23:45:00Z

Motivation

I added documents for the installation right now. Other files like docs/en/quick_start.md could be ignored and I will wrap it into index.rst later.

Modifications

#1487

Checklist

Format your code according to the Contributor Guide.
Add unit tests as outlined in the Contributor Guide.
Update documentation as needed, including docstrings or example tutorials.

docs/en/install.md

merrymercy · 2024-10-21T00:46:44Z

docs/en/quick_start.md

+# Server Quick Start
+
+This guide will help you quickly set up and run the SGLang server, and send test requests for both generative and embedding models.
+


Current outline

- Step 1 - Generative model (90% user) - Embedding model (10% user) - Step 2 - Generative model (90% user) - Embedding model (10% user)

Correct outline

- Generative model (90% user) - Step 1 - Step 2 - Embedding model (10% user) - Step 1 - Step 2

merrymercy · 2024-10-21T00:48:23Z

Principal:

Common case first, move edge cases to the end
Make it concise
Make the commands runnable and continuous

zhaochenyang20 · 2024-10-21T03:17:22Z

@merrymercy Hey, plz check if this version of install.md is what you'd prefer.

ByronHsu · 2024-10-21T07:07:44Z

docs/en/backend_overview.md

@@ -0,0 +1,40 @@
+# Backend Overview


Is this file necessary? i think the paper already provides a good overview

This document serves as a learning guide, and I believe it is necessary. As you can gain insights from the Stoicheia, there remains a need to acquire new Geometry material. Anyway, I will set this aside for now and ensure it is placed appropriately later.

docs/en/index.rst

merrymercy · 2024-10-21T19:12:57Z

docs/en/add_new_model.md

@@ -1,4 +1,4 @@
-# How to Support a New Model
+# Add New Models


revert the change of this file, and only keep install.md

merrymercy · 2024-10-21T19:13:07Z

docs/en/index.rst

@@ -1,14 +1,20 @@
 SGLang Documentation


revert the change of this file, and only keep install.md

merrymercy · 2024-10-21T19:14:13Z

docs/en/install.md

 pip install --upgrade pip
 pip install "sglang[all]"
-
-# Install FlashInfer CUDA kernels


merrymercy · 2024-10-21T19:14:53Z

docs/en/install.md

    lmsysorg/sglang:latest \
-    python3 -m sglang.launch_server --model-path meta-llama/Llama-3.1-8B-Instruct --host 0.0.0.0 --port 30000
+    python3 -m sglang.launch_server --model-path meta-llama/Meta-Llama-3.1-8B-Instruct --host 0.0.0.0 --port 30000


revert this line

zhaochenyang20 · 2024-10-21T19:25:13Z

thanks for help @merrymercy @ByronHsu