Skip to content

Commit

Permalink
Add a doc for installation (#128)
Browse files Browse the repository at this point in the history
  • Loading branch information
WoosukKwon authored May 27, 2023
1 parent d721168 commit 56b7f0e
Showing 1 changed file with 41 additions and 1 deletion.
42 changes: 41 additions & 1 deletion docs/source/getting_started/installation.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,50 @@
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.0 -- 11.8
* GPU: compute capability 7.0 or higher (e.g., V100, T4, RTX20xx, A100, etc.)

.. note::
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.

.. code-block:: console
$ docker run --gpus all -it --rm --shm-size=8g nvcr.io/nvidia/pytorch:22.12-py3
Install with pip
----------------

You can install CacheFlow using pip:

.. code-block:: console
$ # (Optional) Create a new conda environment.
$ conda create -n myenv python=3.8 -y
$ conda activate myenv
$ # 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.
$ pip install -e . # This may take 5-10 minutes.

0 comments on commit 56b7f0e

Please sign in to comment.