ipex-llm/docs/readthedocs/source/doc/Nano/Overview/install.md

Nano Installation

You can select bigdl-nano along with some dependencies specific to PyTorch or Tensorflow using the following panel.

.. raw:: html

    <link rel="stylesheet" type="text/css" href="../../../_static/css/installation_panel.css" />

    <div class="installation-panel-wrapper">
      <table class="installation-panel-table">
        <tbody>
          <tr>
            <td colspan="1">FrameWork</td>
            <td colspan="2"><button id="pytorch" class="install_option_button">PyTorch</button></td>
            <td colspan="2"><button id="tensorflow" class="install_option_button">TensorFlow</button></td>
          </tr>
          <tr id="version">
            <td colspan="1">Version</td>
            <td colspan="1"><button id="pytorch_113" class="install_option_button">1.13</button></td>
            <td colspan="1"><button id="pytorch_112" class="install_option_button">1.12</button></td>
            <td colspan="1"><button id="pytorch_111" class="install_option_button">1.11</button></td>
            <td colspan="1"><button id="pytorch_110" class="install_option_button">1.10</button></td>
          </tr>
          <tr>
            <td colspan="1">Inference Opt</td>
            <td colspan="2"><button id="inference_yes" class="install_option_button">Yes</button></td>
            <td colspan="2"><button id="inference_no" class="install_option_button">No</button></td>
          </tr>
          <tr>
            <td colspan="1">Release</td>
            <td colspan="2"><button id="nightly" class="install_option_button">Nightly</button></td>
            <td colspan="2"><button id="stable" class="install_option_button">Stable</button></td>
          </tr>
          <tr>
            <td colspan="1">Install CMD</td>
            <td colspan="4" id="cmd">NA</td>
          </tr>
        </tbody>
      </table>
    </div>

    <script src="../../../_static/js/nano_installation_panel.js"></script>

.. 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.

    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

Install in conda environment (Recommended)

conda create -n env
conda activate env

# select your preference in above panel to find the proper command to replace the below command, e.g.
pip install --pre --upgrade bigdl-nano[pytorch]

# after installing bigdl-nano, you can run the following command to setup a few environment variables.
source bigdl-nano-init

The bigdl-nano-init scripts will export a few environment variable according to your hardware to maximize performance.

In a conda environment, when you run source bigdl-nano-init manually, this command will also be added to $CONDA_PREFIX/etc/conda/activate.d/, which will automaticly run when you activate your current environment.

Install in pure pip environment

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. 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

bigdl-nano is validated on Python 3.8-3.9.

Operating System

Some specific note should be awared of when installing bigdl-nano.`

Install on Linux

For Linux, Ubuntu (22.04/20.04) is recommended.

Install on Windows (experimental support)

For Windows OS, users could only run bigdl-nano-init every time they open a new cmd terminal.

We recommend using Windows Subsystem for Linux 2 (WSL2) to run BigDL-Nano. Please refer to Nano Windows install guide for instructions.

Install on MacOS (experimental support)

MacOS with Intel Chip

Same usage as Linux, while some of the funcions now rely on lower version dependencies.

MacOS with M-series chip

Currently, only tensorflow is supported for M-series chip Mac.

# any way to install tensorflow on macos

pip install --pre --upgrade bigdl-nano[tensorflow]