From 28acefdb7c1cfd2db3121871dc0e3d6a27cda154 Mon Sep 17 00:00:00 2001
From: Junwei Deng <35031544+TheaperDeng@users.noreply.github.com>
Date: Mon, 10 Oct 2022 17:31:02 +0800
Subject: [PATCH] Chronos: update installation guide to reflect our work on
better tensorflow support (#6066)
---
.../_static/js/chronos_installation_guide.js | 50 ++++++++++++++-----
.../source/doc/Chronos/Overview/chronos.md | 13 ++---
2 files changed, 41 insertions(+), 22 deletions(-)
diff --git a/docs/readthedocs/source/_static/js/chronos_installation_guide.js b/docs/readthedocs/source/_static/js/chronos_installation_guide.js
index 42c5042e..b9fbae35 100644
--- a/docs/readthedocs/source/_static/js/chronos_installation_guide.js
+++ b/docs/readthedocs/source/_static/js/chronos_installation_guide.js
@@ -103,13 +103,13 @@ function refresh_cmd(){
if(version=="nightly"){
cmd="pip install --pre --upgrade bigdl-chronos[pytorch]";
}else if(version=="stable"){
- cmd="pip install bigdl-chronos";
+ cmd="pip install bigdl-chronos[pytorch]";
}
}else if(hardware=="cluster"){
if(version=="nightly"){
cmd="pip install --pre --upgrade bigdl-chronos[pytorch,distributed]";
}else if(version=="stable"){
- cmd="pip install bigdl-chronos[all]";
+ cmd="pip install bigdl-chronos[pytorch,distributed]";
}
}
}else if(automl=="automlyes"){
@@ -117,19 +117,45 @@ function refresh_cmd(){
if(version=="nightly"){
cmd="pip install --pre --upgrade bigdl-chronos[pytorch,automl]";
}else if(version=="stable"){
- cmd="pip install bigdl-chronos[all]";
+ cmd="pip install bigdl-chronos[pytorch,automl]";
}
}else if(hardware=="cluster"){
if(version=="nightly"){
cmd="pip install --pre --upgrade bigdl-chronos[pytorch,distributed,automl]";
}else if(version=="stable"){
- cmd="pip install bigdl-chronos[all]";
+ cmd="pip install bigdl-chronos[pytorch,distributed,automl]";
}
}
}
}else if(ai=="tensorflow"){
- if(package=="pypi"&&os=="linux"){
- cmd="Please refer to tensorflow installation guide. "
+ if(automl=="automlno"){
+ if(hardware=="singlenode"){
+ if(version=="nightly"){
+ cmd="pip install --pre --upgrade bigdl-chronos[tensorflow]";
+ }else if(version=="stable"){
+ cmd="Please refer to tensorflow installation guide. ";
+ }
+ }else if(hardware=="cluster"){
+ if(version=="nightly"){
+ cmd="pip install --pre --upgrade bigdl-chronos[tensorflow,distributed]";
+ }else if(version=="stable"){
+ cmd="Please refer to tensorflow installation guide. ";
+ }
+ }
+ }else if(automl=="automlyes"){
+ if(hardware=="singlenode"){
+ if(version=="nightly"){
+ cmd="pip install --pre --upgrade bigdl-chronos[tensorflow,automl]";
+ }else if(version=="stable"){
+ cmd="Please refer to tensorflow installation guide. ";
+ }
+ }else if(hardware=="cluster"){
+ if(version=="nightly"){
+ cmd="pip install --pre --upgrade bigdl-chronos[tensorflow,distributed,automl]";
+ }else if(version=="stable"){
+ cmd="Please refer to tensorflow installation guide. ";
+ }
+ }
}
}
}else if(model=="Prophet"){
@@ -144,7 +170,7 @@ function refresh_cmd(){
if(version=="nightly"){
cmd="pip install --pre --upgrade bigdl-chronos[distributed]; pip install prophet==1.1.0";
}else if(version=="stable"){
- cmd="pip install bigdl-chronos[all]; pip install prophet==1.1.0";
+ cmd="pip install bigdl-chronos[distributed]; pip install prophet==1.1.0";
}
}
}else if(automl=="automlyes"){
@@ -152,13 +178,13 @@ function refresh_cmd(){
if(version=="nightly"){
cmd="pip install --pre --upgrade bigdl-chronos[distributed]; pip install prophet==1.1.0";
}else if(version=="stable"){
- cmd="pip install bigdl-chronos[all]; pip install prophet==1.1.0";
+ cmd="pip install bigdl-chronos[distributed]; pip install prophet==1.1.0";
}
}else if(hardware=="cluster"){
if(version=="nightly"){
cmd="pip install --pre --upgrade bigdl-chronos[distributed]; pip install prophet==1.1.0";
}else if(version=="stable"){
- cmd="pip install bigdl-chronos[all]; pip install prophet==1.1.0";
+ cmd="pip install bigdl-chronos[distributed]; pip install prophet==1.1.0";
}
}
}
@@ -174,7 +200,7 @@ function refresh_cmd(){
if(version=="nightly"){
cmd="pip install --pre --upgrade bigdl-chronos[distributed]; pip install pmdarima==1.8.5";
}else if(version=="stable"){
- cmd="pip install bigdl-chronos[all]; pip install pmdarima==1.8.5";
+ cmd="pip install bigdl-chronos[distributed]; pip install pmdarima==1.8.5";
}
}
}else if(automl=="automlyes"){
@@ -182,13 +208,13 @@ function refresh_cmd(){
if(version=="nightly"){
cmd="pip install --pre --upgrade bigdl-chronos[distributed]; pip install pmdarima==1.8.5";
}else if(version=="stable"){
- cmd="pip install bigdl-chronos[all]; pip install pmdarima==1.8.5";
+ cmd="pip install bigdl-chronos[distributed]; pip install pmdarima==1.8.5";
}
}else if(hardware=="cluster"){
if(version=="nightly"){
cmd="pip install --pre --upgrade bigdl-chronos[distributed]; pip install pmdarima==1.8.5";
}else if(version=="stable"){
- cmd="pip install bigdl-chronos[all]; pip install pmdarima==1.8.5";
+ cmd="pip install bigdl-chronos[distributed]; pip install pmdarima==1.8.5";
}
}
}
diff --git a/docs/readthedocs/source/doc/Chronos/Overview/chronos.md b/docs/readthedocs/source/doc/Chronos/Overview/chronos.md
index b3988927..67d8bf68 100644
--- a/docs/readthedocs/source/doc/Chronos/Overview/chronos.md
+++ b/docs/readthedocs/source/doc/Chronos/Overview/chronos.md
@@ -115,10 +115,10 @@ You can use _Chronos_ to:
Version
Nightly (2.1.0b)
+ title="For users would like to try chronos's latest feature">Nightly (2.2.0b)
Stable (2.0.0)
@@ -146,14 +146,7 @@ pip install --pre --upgrade bigdl-chronos[pytorch] # or other options you may w
source bigdl-nano-init # accelerate the conda env
```
-#### **2.2 Tensorflow backend**
-Tensorflow is one of the supported backend of Chronos in nightly release version, while it can not work alone without pytorch in Chronos for now. We will fix it soon. If you want to use tensorflow backend, please
-```bash
-pip install --pre --upgrade bigdl-nano[tensorflow]
-```
-**after you install the pytorch backend chronos.**
-
-#### **2.3 OS and Python version requirement**
+#### **2.2 OS and Python version requirement**
```eval_rst
.. note::