diff --git a/README.md b/README.md index 3def732..2bdbe5f 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,19 @@ This repository contains the Docker configuration and startup scripts to run a multi-node vLLM inference cluster using Ray. It supports InfiniBand/RDMA (NCCL) and custom environment configuration for high-performance setups. +## Table of Contents + +- [DISCLAIMER](#disclaimer) +- [CHANGELOG](#changelog) +- [1. Building the Docker Image](#1-building-the-docker-image) +- [2. Launching the Cluster (Recommended)](#2-launching-the-cluster-recommended) +- [3. Running the Container (Manual)](#3-running-the-container-manual) +- [4. Using `run-cluster-node.sh` (Internal)](#4-using-run-cluster-nodesh-internal) +- [5. Configuration Details](#5-configuration-details) +- [6. Using cluster mode for inference](#6-using-cluster-mode-for-inference) +- [7. Fastsafetensors](#7-fastsafetensors) +- [8. Benchmarking](#8-benchmarking) + ## DISCLAIMER This repository is not affiliated with NVIDIA or their subsidiaries. The content is provided as a reference material only, not intended for production use.