Skip to content
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

Add a doc for installation #128

Merged
merged 5 commits into from
May 27, 2023
Merged
Changes from 1 commit
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
Next Next commit
Add instructions for installation
  • Loading branch information
WoosukKwon committed May 25, 2023
commit 0af2a89db31e007a531e91b30239566d50dab0ec
36 changes: 36 additions & 0 deletions docs/source/getting_started/installation.rst
Original file line number Diff line number Diff line change
@@ -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.