From 0af2a89db31e007a531e91b30239566d50dab0ec Mon Sep 17 00:00:00 2001 From: woWoosuk Kwon Date: Thu, 25 May 2023 08:00:25 +0000 Subject: [PATCH 1/5] Add instructions for installation --- docs/source/getting_started/installation.rst | 36 ++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/docs/source/getting_started/installation.rst b/docs/source/getting_started/installation.rst index aab424c61ae0..8f1fd0972be4 100644 --- a/docs/source/getting_started/installation.rst +++ b/docs/source/getting_started/installation.rst @@ -1,10 +1,46 @@ Installation ============ +CacheFlow is a Python library that includes some C++ and CUDA code. +CacheFlow can run on systems that meet the following requirements: + +* OS: Linux +* Python: 3.8 or higher +* CUDA: 11.3 or higher (**Needs to be checked!!**) +* GPU: compute capability 7.0 or higher (V100, T4, RTX20xx, A100, etc.) + +.. tip:: + If you have trouble installing CacheFlow, we recommend using the NVIDIA PyTorch Docker image. + + .. code-block:: console + + $ docker run --gpus all -it --rm --shm-size=64g --ulimit memlock=-1 --ulimit stack=67108864 nvcr.io/nvidia/pytorch:23.04-py3 + +Install with pip +---------------- + +Install CacheFlow using pip: + +.. code-block:: console + + $ # (Optional) Create a new conda environment. + $ conda create -n cf python=3.8 -y + $ conda activate cf + + $ # Install CacheFlow. + $ pip install cacheflow + + +.. _build_from_source: + Build from source ----------------- +You can also build and install CacheFlow from source. + .. code-block:: console + $ git clone https://github.com/WoosukKwon/cacheflow.git + $ cd cacheflow $ pip install -r requirements.txt $ pip install -e . # This may take several minutes. From 3903a86ac02e582706015d8c8c95990dd28487c6 Mon Sep 17 00:00:00 2001 From: woWoosuk Kwon Date: Fri, 26 May 2023 05:31:48 +0000 Subject: [PATCH 2/5] Fix installation --- docs/source/getting_started/installation.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/getting_started/installation.rst b/docs/source/getting_started/installation.rst index 8f1fd0972be4..767c04ba39b7 100644 --- a/docs/source/getting_started/installation.rst +++ b/docs/source/getting_started/installation.rst @@ -6,7 +6,7 @@ CacheFlow can run on systems that meet the following requirements: * OS: Linux * Python: 3.8 or higher -* CUDA: 11.3 or higher (**Needs to be checked!!**) +* CUDA: 11.3 or higher * GPU: compute capability 7.0 or higher (V100, T4, RTX20xx, A100, etc.) .. tip:: @@ -14,7 +14,7 @@ CacheFlow can run on systems that meet the following requirements: .. code-block:: console - $ docker run --gpus all -it --rm --shm-size=64g --ulimit memlock=-1 --ulimit stack=67108864 nvcr.io/nvidia/pytorch:23.04-py3 + $ docker run --gpus all -it --rm --shm-size=8g nvcr.io/nvidia/pytorch:23.04-py3 Install with pip ---------------- From 1a7604b1533d05694be85348bb2cfc08f300b3e2 Mon Sep 17 00:00:00 2001 From: woWoosuk Kwon Date: Sat, 27 May 2023 06:23:42 +0000 Subject: [PATCH 3/5] Fix CUDA version in installation --- docs/source/getting_started/installation.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/source/getting_started/installation.rst b/docs/source/getting_started/installation.rst index 767c04ba39b7..dc7404f34b31 100644 --- a/docs/source/getting_started/installation.rst +++ b/docs/source/getting_started/installation.rst @@ -6,15 +6,18 @@ CacheFlow can run on systems that meet the following requirements: * OS: Linux * Python: 3.8 or higher -* CUDA: 11.3 or higher +* CUDA: 11.0 -- 11.8 * GPU: compute capability 7.0 or higher (V100, T4, RTX20xx, A100, etc.) +.. note:: + Currently, CacheFlow does not support CUDA 12. + .. tip:: If you have trouble installing CacheFlow, we recommend using the NVIDIA PyTorch Docker image. .. code-block:: console - $ docker run --gpus all -it --rm --shm-size=8g nvcr.io/nvidia/pytorch:23.04-py3 + $ docker run --gpus all -it --rm --shm-size=8g nvcr.io/nvidia/pytorch:22.12-py3 Install with pip ---------------- From a0fa70a84f653ea390bcb17efc0fcd525b8cd52b Mon Sep 17 00:00:00 2001 From: woWoosuk Kwon Date: Sat, 27 May 2023 08:07:51 +0000 Subject: [PATCH 4/5] Fix installation doc --- docs/source/getting_started/installation.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/source/getting_started/installation.rst b/docs/source/getting_started/installation.rst index dc7404f34b31..be8e13c0e6b4 100644 --- a/docs/source/getting_started/installation.rst +++ b/docs/source/getting_started/installation.rst @@ -10,7 +10,8 @@ CacheFlow can run on systems that meet the following requirements: * GPU: compute capability 7.0 or higher (V100, T4, RTX20xx, A100, etc.) .. note:: - Currently, CacheFlow does not support CUDA 12. + As of now, CacheFlow does not support CUDA 12. + If you are using Hopper or Lovelace GPUs, please use CUDA 11.8. .. tip:: If you have trouble installing CacheFlow, we recommend using the NVIDIA PyTorch Docker image. @@ -22,13 +23,13 @@ CacheFlow can run on systems that meet the following requirements: Install with pip ---------------- -Install CacheFlow using pip: +You can install CacheFlow using pip: .. code-block:: console $ # (Optional) Create a new conda environment. - $ conda create -n cf python=3.8 -y - $ conda activate cf + $ conda create -n myenv python=3.8 -y + $ conda activate myenv $ # Install CacheFlow. $ pip install cacheflow @@ -46,4 +47,4 @@ You can also build and install CacheFlow from source. $ git clone https://github.com/WoosukKwon/cacheflow.git $ cd cacheflow $ pip install -r requirements.txt - $ pip install -e . # This may take several minutes. + $ pip install -e . # This may take 5-10 minutes. From 0f932862bf579598554b103ccf0321031f83b180 Mon Sep 17 00:00:00 2001 From: woWoosuk Kwon Date: Sat, 27 May 2023 08:11:48 +0000 Subject: [PATCH 5/5] Minor --- docs/source/getting_started/installation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/getting_started/installation.rst b/docs/source/getting_started/installation.rst index be8e13c0e6b4..ee1215416c2f 100644 --- a/docs/source/getting_started/installation.rst +++ b/docs/source/getting_started/installation.rst @@ -7,7 +7,7 @@ CacheFlow can run on systems that meet the following requirements: * OS: Linux * Python: 3.8 or higher * CUDA: 11.0 -- 11.8 -* GPU: compute capability 7.0 or higher (V100, T4, RTX20xx, A100, etc.) +* GPU: compute capability 7.0 or higher (e.g., V100, T4, RTX20xx, A100, etc.) .. note:: As of now, CacheFlow does not support CUDA 12.