ayo/ipex-llm
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Nano: Add some user guide and warning messages according to feedback (#7374)

Browse source
This commit is contained in:
Junwei Deng 2023-02-01 08:53:08 +08:00 committed by GitHub
parent 4568403d47
commit 90c76ce7a2
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/readthedocs/source/doc/Nano/Overview/install.md
View file

@ -48,7 +48,7 @@ You can select bigdl-nano along with some dependencies specific to PyTorch or Te
.. note:: .. note::
Since bigdl-nano is still in the process of rapid iteration, we highly recommend that you install nightly build version through the above command to facilitate your use of the latest features. Since bigdl-nano is still in the process of rapid iteration, we highly recommend that you install nightly build version through the above command to facilitate your use of the latest features.
For stable version, please refer to the document and installation guide `here <https://bigdl.readthedocs.io/en/v2.1.0/doc/Nano/Overview/nano.html>`_ . For stable version, please refer to the document and installation guide `here <https://bigdl.readthedocs.io/en/v2.2.0/doc/Nano/Overview/install.html>`_ .
``` ```
## Environment Management ## Environment Management
@ -74,6 +74,9 @@ In a conda environment, when you run `source bigdl-nano-init` manually, this com
In a pure pip environment, you need to run `source bigdl-nano-init` every time you open a new shell to get optimal performance and run `source bigdl-nano-unset-env` if you want to unset these environment variables. In a pure pip environment, you need to run `source bigdl-nano-init` every time you open a new shell to get optimal performance and run `source bigdl-nano-unset-env` if you want to unset these environment variables.
## Other PyTorch/Tensorflow Version Support
We support a wide range of PyTorch and Tensorflow. We only care the MAJOR.MINOR in [Semantic Versioning](https://semver.org/). If you have a specific PyTorch/Tensorflow version want to use, e.g. PyTorch 1.11.0+cpu, you may select corresponding MAJOR.MINOR (i.e., PyTorch 1.11 in this case) and install PyTorch again after installing nano.
## Python Version ## Python Version
`bigdl-nano` is validated on Python 3.7-3.9. `bigdl-nano` is validated on Python 3.7-3.9.