[feature] add bat for windows, update readme

This commit is contained in:
chenxl 2024-08-09 09:39:42 +00:00
parent 1f92f7cc61
commit 782a17e4e6
4 changed files with 26 additions and 4 deletions

View File

@ -82,11 +82,12 @@ Some preparation:
<h3>Installation</h3> <h3>Installation</h3>
1. Use a Docker image, see [documentation for Docker](./doc/en/docker.md) 1. Use a Docker image, see [documentation for Docker](./doc/en/docker.md)
2. You can install using Pypi: 2. You can install using Pypi (for linux):
``` ```
pip install ktransformers --no-build-isolation pip install ktransformers --no-build-isolation
``` ```
for windows we prepare a pre compiled whl package in [ktransformers-0.1.1+cu125torch24avx2-cp311-cp311-win_amd64.whl](https://github.com/kvcache-ai/ktransformers/releases/download/v0.1.1/ktransformers-0.1.1+cu125torch24avx2-cp311-cp311-win_amd64.whl), which require cuda-12.5, torch-2.4, python-3.11, more pre compiled package are being produced.
3. Or you can download source code and compile: 3. Or you can download source code and compile:
- init source code - init source code
@ -97,11 +98,16 @@ Some preparation:
git submodule update git submodule update
``` ```
- [Optional] If you want to run with website, please [compile the website](./doc/en/api/server/website.md) before execute ```bash install.sh``` - [Optional] If you want to run with website, please [compile the website](./doc/en/api/server/website.md) before execute ```bash install.sh```
- Compile and install - Compile and install (for Linux)
``` ```
bash install.sh bash install.sh
``` ```
- Compile and install(for Windows)
```
install.bat
```
<h3>Local Chat</h3> <h3>Local Chat</h3>
We provide a simple command-line local chat Python script that you can run for testing. We provide a simple command-line local chat Python script that you can run for testing.

16
install.bat Normal file
View File

@ -0,0 +1,16 @@
@echo off
REM clear build dirs
rmdir /S /Q ktransformers\ktransformers_ext\build
rmdir /S /Q ktransformers\ktransformers_ext\cuda\build
rmdir /S /Q ktransformers\ktransformers_ext\cuda\dist
rmdir /S /Q ktransformers\ktransformers_ext\out
del /F /Q ktransformers\ktransformers_ext\cuda\*.egg-info
echo Installing python dependencies from requirements.txt
pip install -r requirements-local_chat.txt
echo Installing ktransformers
set KTRANSFORMERS_FORCE_BUILD=TRUE
pip install . --no-build-isolation
echo Installation completed successfully

View File

@ -11,5 +11,5 @@ echo "Installing python dependencies from requirements.txt"
pip install -r requirements-local_chat.txt pip install -r requirements-local_chat.txt
echo "Installing ktransformers" echo "Installing ktransformers"
pip install . --no-build-isolation KTRANSFORMERS_FORCE_BUILD=TRUE pip install . --no-build-isolation
echo "Installation completed successfully" echo "Installation completed successfully"

View File

@ -1,4 +1,4 @@
cmake_minimum_required(VERSION 3.17) cmake_minimum_required(VERSION 3.16)
project(cpuinfer_ext VERSION 0.1.0) project(cpuinfer_ext VERSION 0.1.0)
set(CMAKE_CXX_STANDARD 17) set(CMAKE_CXX_STANDARD 17)