From 9304e074234ebb6a66ff41695876a6d6d790ee76 Mon Sep 17 00:00:00 2001 From: osanseviero Date: Thu, 10 Aug 2023 10:19:55 +0200 Subject: [PATCH] Move launch locally to an installation section --- docs/source/_toctree.yml | 4 ++-- .../local_launch.md => installation.md} | 11 +++++++++-- 2 files changed, 11 insertions(+), 4 deletions(-) rename docs/source/{basic_tutorials/local_launch.md => installation.md} (85%) diff --git a/docs/source/_toctree.yml b/docs/source/_toctree.yml index d75b802c..8ee20eb0 100644 --- a/docs/source/_toctree.yml +++ b/docs/source/_toctree.yml @@ -3,12 +3,12 @@ title: Text Generation Inference - local: quicktour title: Quick Tour + - local: installation + title: Installation - local: supported_models title: Supported Models and Hardware title: Getting started - sections: - - local: basic_tutorials/local_launch - title: Installing from the Source and Launching TGI - local: basic_tutorials/consuming_tgi title: Consuming TGI - local: basic_tutorials/preparing_model diff --git a/docs/source/basic_tutorials/local_launch.md b/docs/source/installation.md similarity index 85% rename from docs/source/basic_tutorials/local_launch.md rename to docs/source/installation.md index ed9b5442..4105acf4 100644 --- a/docs/source/basic_tutorials/local_launch.md +++ b/docs/source/installation.md @@ -1,9 +1,16 @@ -# Installing from the Source and Launching TGI +# Installation + +This section explains how to install the CLI tool as well as installing TGI from source. **The strongly recommended approach is to use Docker, as it does not require much setup. Check [the Quick Tour](./quicktour) to learn how to run TGI with Docker.** + +## Install CLI + +TODO -Before you start, you will need to setup your environment, and install Text Generation Inference. Text Generation Inference is tested on **Python 3.9+**. ## Local Installation from Source +Before you start, you will need to setup your environment, and install Text Generation Inference. Text Generation Inference is tested on **Python 3.9+**. + Text Generation Inference is available on pypi, conda and GitHub. To install and launch locally, first [install Rust](https://rustup.rs/) and create a Python virtual environment with at least