Skip to content

Add a doc for installation #128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 27, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.