[DOCS] Updated and improved docs (#73)
This commit is contained in:
committed by
Philippe Tillet
parent
3ecf834a69
commit
0c13b8ff0e
@@ -1,21 +1,52 @@
|
||||
***************
|
||||
==============
|
||||
From Source
|
||||
***************
|
||||
==============
|
||||
|
||||
Triton is a fairly self-contained package and uses its own parser (forked from `wgtcc <https://github.com/wgtdkp/wgtcc>`_) and LLVM-8.0+ for code generation.
|
||||
+++++++++++++++
|
||||
Python Package
|
||||
+++++++++++++++
|
||||
|
||||
You can install the Python package from source by running the following commands:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo apt-get install llvm-8-dev
|
||||
git clone https://github.com/ptillet/triton.git;
|
||||
cd triton/python/;
|
||||
python setup.py develop;
|
||||
sudo apt-get install llvm-10-dev
|
||||
git clone https://github.com/ptillet/triton.git;
|
||||
cd triton/python;
|
||||
pip install -e .
|
||||
|
||||
This should take about 15-20 seconds to compile on a modern machine.
|
||||
|
||||
You can then test your installation by running the *einsum.py* example in an environment that contains pytorch:
|
||||
You can then test your installation by running the unit tests:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
cd examples;
|
||||
python einsum.py
|
||||
pytest -vs .
|
||||
|
||||
and the benchmarks
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
cd bench/
|
||||
python -m run --with-plots --result-dir /tmp/triton-bench
|
||||
|
||||
+++++++++++++++
|
||||
C++ Package
|
||||
+++++++++++++++
|
||||
|
||||
Those not interested in Python integration may want to use the internals of Triton (i.e, runtime, parser, codegen, driver, intermediate representation) directly. This can be done by running the following commands:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo apt-get install llvm-10-dev
|
||||
git clone https://github.com/ptillet/triton.git;
|
||||
mkdir build;
|
||||
cd build;
|
||||
cmake ../;
|
||||
make -j8;
|
||||
|
||||
A custom llvm-config binary can also be provided:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
cmake ../ -DLLVM_CONFIG=/path/to/llvm-config
|
||||
|
||||
Note that while direct usage of the C++ API is not officially supported, a usage tutorial can be found `here <https://github.com/ptillet/triton/blob/master/tutorials/01-matmul.cc>`_
|
||||
|
Reference in New Issue
Block a user