Chronos: Add a page 'Windows User Guide.md' to ReadTheDocs (#5263)

* Add files via upload

* Update _toc.yml

* Update windows_guide.md

* r

* Delete windows_guide.html
This commit is contained in:
Ziyao Peng 2022-08-08 17:41:29 +08:00 committed by GitHub
parent f682f79166
commit 41f602fcec
2 changed files with 47 additions and 0 deletions

View file

@ -52,6 +52,7 @@ subtrees:
- caption: Chronos - caption: Chronos
entries: entries:
- file: doc/Chronos/Overview/chronos - file: doc/Chronos/Overview/chronos
- file: doc/Chronos/Overview/windows_guide
- file: doc/Chronos/Overview/deep_dive - file: doc/Chronos/Overview/deep_dive
- file: doc/Chronos/QuickStart/index - file: doc/Chronos/QuickStart/index
- file: doc/Chronos/Overview/chronos_known_issue - file: doc/Chronos/Overview/chronos_known_issue

View file

@ -0,0 +1,46 @@
# Chronos Windows User Guide
## Step 1: Install WSL2
For Windows, we recommend using Windows Subsystem for Linux 2 (WSL2) to run BigDL-Chronos.
To install WSL2, you can now install everything you need by entering this command in an administrator PowerShell or Windows Command Prompt and then restarting your machine.
```powershell
wsl --install
```
By default, this command should install the latest required components for WSL2 and install Ubuntu as default distribution for you.
To run this command, you must be running Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11. If you're running an older build, or just prefer not to use the install command and would like step-by-step directions, see WSL manual installation steps for older versions.
To learn more about installation of WSL2, please Follow [this guide](https://docs.microsoft.com/en-us/windows/wsl/install-win10).
## Step 2: Install conda in WSL2
Start a new WSL2 window and setup the user information. Then download and install the conda.
```bash
wget https://repo.continuum.io/miniconda/Miniconda3-4.5.4-Linux-x86_64.sh
chmod +x Miniconda3-4.5.4-Linux-x86_64.sh
./Miniconda3-4.5.4-Linux-x86_64.sh
```
## Step 3: Create a BigDL-Chronos env
Use conda to create a new environment. For example, use `bigdl-chronos` as the new environemnt name:
```bash
conda create -n bigdl-chronos python=3.7 setuptools=58.0.4
conda activate bigdl-chronos
```
## Step 4: Install BigDL Chronos from Pypi
You can install BigDL chronos from Pypi with `pip`. Please run:
```
pip install bigdl-chronos
```
For more installation options, please refer to [Chronos User Guide.](https://bigdl.readthedocs.io/en/latest/doc/Chronos/Overview/chronos.html#install)