diff --git a/README.md b/README.md index c81f2a295..dec1e0902 100644 --- a/README.md +++ b/README.md @@ -22,8 +22,9 @@ python3 -m pip install . --no-build-isolation -v Automatic dependency library downloads may be limited by network conditions. You can manually download to the cache directory ~/.flagtree (modifiable via the FLAGTREE_CACHE_DIR environment variable). No need to manually set LLVM environment variables such as LLVM_BUILD_DIR. Complete build commands for each backend: + +[iluvatar](/third_party/iluvatar/) ```shell -# iluvatar # Recommended: Use Ubuntu 20.04 mkdir -p ~/.flagtree/iluvatar; cd ~/.flagtree/iluvatar wget https://github.com/FlagTree/flagtree/releases/download/v0.1.0-build-deps/iluvatar-llvm18-x86_64.tar.gz @@ -32,18 +33,19 @@ cd ${YOUR_CODE_DIR}/flagtree/python export FLAGTREE_BACKEND=iluvatar python3 -m pip install . --no-build-isolation -v ``` +[xpu (klx)](/third_party/xpu/) ```shell -# xpu (klx) # Recommended: Use the Docker image (22GB) https://su.bcebos.com/klx-sdk-release-public/xpytorch/docker/ubuntu2004_v030/ubuntu_2004_x86_64_v30.tar +# Contact kunlunxin-support@baidu.com for support mkdir -p ~/.flagtree/xpu; cd ~/.flagtree/xpu -wget https://github.com/FlagTree/flagtree/releases/download/v0.1.0-build-deps/XTDK-llvm18-ubuntu2004_x86_64.tar +wget https://github.com/FlagTree/flagtree/releases/download/v0.1.0-build-deps/XTDK-llvm19-ubuntu2004_x86_64.tar.gz wget https://github.com/FlagTree/flagtree/releases/download/v0.1.0-build-deps/xre-Linux-x86_64.tar.gz cd ${YOUR_CODE_DIR}/flagtree/python export FLAGTREE_BACKEND=xpu python3 -m pip install . --no-build-isolation -v ``` +[mthreads](https://github.com/FlagTree/flagtree/tree/main/third_party/mthreads/) ```shell -# mthreads # Recommended: Use the Dockerfile flagtree/dockerfiles/Dockerfile-ubuntu22.04-python3.10-mthreads mkdir -p ~/.flagtree/mthreads; cd ~/.flagtree/mthreads wget https://github.com/FlagTree/flagtree/releases/download/v0.1.0-build-deps/mthreads-llvm19-glibc2.34-glibcxx3.4.30-x64.tar.gz @@ -51,8 +53,8 @@ cd ${YOUR_CODE_DIR}/flagtree/python export FLAGTREE_BACKEND=mthreads python3 -m pip install . --no-build-isolation -v ``` +[ascend](https://github.com/FlagTree/flagtree/tree/triton_v3.2.x/third_party/ascend/) ```shell -# ascend # Recommended: Use the Dockerfile flagtree/dockerfiles/Dockerfile-ubuntu20.04-python3.9-ascend # After registering an account at https://www.hiascend.com/developer/download/community/result?module=cann, # download the cann-toolkit and cann-kernels for the corresponding platform. @@ -65,6 +67,7 @@ chmod +x Atlas-A3-cann-kernels_8.1.RC1_linux-aarch64.run mkdir -p ~/.flagtree/ascend; cd ~/.flagtree/ascend wget https://oaitriton.blob.core.windows.net/public/llvm-builds/llvm-b5cc222d-ubuntu-arm64.tar.gz cd ${YOUR_CODE_DIR}/flagtree/python +git checkout -b triton_v3.2.x origin/triton_v3.2.x export FLAGTREE_BACKEND=ascend python3 -m pip install . --no-build-isolation -v ``` diff --git a/README_cn.md b/README_cn.md index a8d66fb8f..86f0e568f 100644 --- a/README_cn.md +++ b/README_cn.md @@ -4,7 +4,7 @@ FlagTree 是多后端的 Triton 编译器项目。FlagTree 致力于打造多元 AI 芯片编译器及相关工具平台,发展和壮大 Triton 上下游生态。项目当前处于初期,目标是兼容现有适配方案,统一代码仓库,快速实现单版本多后端支持。 -## Install from source +## 从源代码安装 安装依赖(注意使用正确的 python3.x 执行): ```shell apt install zlib1g zlib1g-dev libxml2 libxml2-dev # ubuntu @@ -18,12 +18,13 @@ export FLAGTREE_BACKEND=backendxxx python3 -m pip install . --no-build-isolation -v ``` -## Tips for building +## 构建技巧 自动下载依赖库的速度可能受限于网络环境,编译前可自行下载至缓存目录 ~/.flagtree(可通过环境变量 FLAGTREE_CACHE_DIR 修改),无需自行设置 LLVM_BUILD_DIR 等环境变量。 各后端完整编译命令如下: + +[iluvatar](/third_party/iluvatar/) ```shell -# iluvatar # 推荐使用镜像 Ubuntu 20.04 mkdir -p ~/.flagtree/iluvatar; cd ~/.flagtree/iluvatar wget https://github.com/FlagTree/flagtree/releases/download/v0.1.0-build-deps/iluvatar-llvm18-x86_64.tar.gz @@ -32,18 +33,19 @@ cd ${YOUR_CODE_DIR}/flagtree/python export FLAGTREE_BACKEND=iluvatar python3 -m pip install . --no-build-isolation -v ``` +[xpu (klx)](/third_party/xpu/) ```shell -# xpu (klx) # 推荐使用镜像(22GB)https://su.bcebos.com/klx-sdk-release-public/xpytorch/docker/ubuntu2004_v030/ubuntu_2004_x86_64_v30.tar +# 联系 kunlunxin-support@baidu.com 可获取进一步支持 mkdir -p ~/.flagtree/xpu; cd ~/.flagtree/xpu -wget https://github.com/FlagTree/flagtree/releases/download/v0.1.0-build-deps/XTDK-llvm18-ubuntu2004_x86_64.tar +wget https://github.com/FlagTree/flagtree/releases/download/v0.1.0-build-deps/XTDK-llvm19-ubuntu2004_x86_64.tar.gz wget https://github.com/FlagTree/flagtree/releases/download/v0.1.0-build-deps/xre-Linux-x86_64.tar.gz cd ${YOUR_CODE_DIR}/flagtree/python export FLAGTREE_BACKEND=xpu python3 -m pip install . --no-build-isolation -v ``` +[mthreads](https://github.com/FlagTree/flagtree/tree/main/third_party/mthreads/) ```shell -# mthreads # 推荐使用镜像 flagtree/dockerfiles/Dockerfile-ubuntu22.04-python3.10-mthreads mkdir -p ~/.flagtree/mthreads; cd ~/.flagtree/mthreads wget https://github.com/FlagTree/flagtree/releases/download/v0.1.0-build-deps/mthreads-llvm19-glibc2.34-glibcxx3.4.30-x64.tar.gz @@ -51,8 +53,8 @@ cd ${YOUR_CODE_DIR}/flagtree/python export FLAGTREE_BACKEND=mthreads python3 -m pip install . --no-build-isolation -v ``` +[ascend](https://github.com/FlagTree/flagtree/tree/triton_v3.2.x/third_party/ascend/) ```shell -# ascend # 推荐使用镜像 flagtree/dockerfiles/Dockerfile-ubuntu20.04-python3.9-ascend # 在 https://www.hiascend.com/developer/download/community/result?module=cann # 注册账号后下载对应平台的 cann-toolkit、cann-kernels,这里以 AArch64 架构的 A3 处理器为例展示如何安装 @@ -86,7 +88,7 @@ python3 -m pip install . --no-build-isolation -v unset LLVM_BUILD_DIR LLVM_INCLUDE_DIRS LLVM_LIBRARY_DIR LLVM_SYSPATH ``` -## Running tests +## 运行测试 安装完成后可以在后端目录下运行测试: ```shell @@ -94,10 +96,10 @@ cd third_party/backendxxx/python/test python3 -m pytest -s ``` -## Contributing +## 关于贡献 欢迎参与 FlagTree 的开发并贡献代码,详情请参考[CONTRIBUTING.md](/CONTRIBUTING_cn.md)。 -## License +## 许可证 FlagTree 使用 [MIT license](/LICENSE)。