update installation in readme (#184)

PaddlePaddle · Jan 17, 2023 · a86d924 · a86d924
1 parent eba6f78
commit a86d924
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -42,6 +42,28 @@
 
 ## Installation
 
+PLSC provides two usage methods: one is as an external third-party library, and users can use `import plsc` in their own projects; the other is to develop and use it locally based on this repository.
+
+**Note**: As the PaddlePaddle version continues to iterate, PLSC v2.4 adapts to PaddlePaddle v2.4, and there may be API mismatches in higher versions of PaddlePaddle.
+
+### Install plsc as a third-party library
+
+```shell
+pip install plsc==2.4
+```
+
+### Install plsc locally
+
+```shell
+git clone https://github.com/PaddlePaddle/PLSC.git
+cd /path/to/PLSC/
+
+git checkout -b release/2.4 remotes/origin/release/2.4
+
+# [optional] pip install -r requirements.txt
+python setup.py develop
+```
+
 See [Installation instructions](./tutorials/get_started/installation.md).
 
 

diff --git a/requirements.txt b/requirements.txt
@@ -8,8 +8,8 @@ requests
 prettytable
 tqdm
 visualdl
-scikit-learn==0.23.2
-opencv-python==4.4.0.46
+scikit-learn>=0.23.2
+opencv-python>=4.2.0.32
 onnxruntime-gpu==1.10.0
 onnx==1.9.0
 paddle2onnx==0.9.4
diff --git a/tutorials/get_started/installation.md b/tutorials/get_started/installation.md
@@ -15,6 +15,8 @@ git clone https://github.com/PaddlePaddle/Paddle.git
 
 cd /path/to/Paddle/
 
+git checkout -b release/2.4 remotes/origin/release/2.4
+
 mkdir build && cd build
 
 cmake .. -DWITH_TESTING=OFF -DWITH_GPU=ON -DWITH_GOLANG=OFF -DWITH_STYLE_CHECK=ON -DCMAKE_INSTALL_PREFIX=$PWD/output -DWITH_DISTRIBUTE=ON -DCMAKE_BUILD_TYPE=Release -DPY_VERSION=3.7