diff --git a/docs/readthedocs/source/_static/css/nano_installation_guide.css b/docs/readthedocs/source/_static/css/nano_installation_guide.css index 64f35f82..4eb8fae9 100644 --- a/docs/readthedocs/source/_static/css/nano_installation_guide.css +++ b/docs/readthedocs/source/_static/css/nano_installation_guide.css @@ -7,34 +7,32 @@ #table-1 { border-bottom-width: 0px; - margin:auto; + margin: auto; + font-size: var(--pst-font-size-base); + font-family: Verdana; + color: var(--pst-color-text-base); } #table-1 tr, td{ + padding: 0.5rem; background-color: var(--pst-color-on-surface); - height: 30px; - border-width: 2px; - border-style: solid; - border-color: white ; - padding: 5px; +} + +#table-1 td{ + border: 0.25rem solid var(--pst-color-background); + width: 150px; } #table-1 tr td:first-child{ font-weight: 600; -} - -#table-1 td{ - font-size: 16px; - font-family: Verdana; - color: var(--pst-color-text-base); - text-align: center; - /* height: 56px; - line-height: 56px; */ - width: 160px; + background-color: var(--pst-color-background); + border-left: 0.2rem solid var(--pst-color-on-surface); + text-align: left; + width: 170px; + font-size: 13.5px; } #table-1 button { - font-size: 16px; border-color: transparent; width: 100%; height: 100%; @@ -43,10 +41,6 @@ } #table-1 #cmd { - height: 2em; text-align: left; + padding: 0.5rem 0.25rem } - -#table-1 .taller_tr { - height: 71px; -} \ No newline at end of file diff --git a/docs/readthedocs/source/_static/js/nano_installation_guide.js b/docs/readthedocs/source/_static/js/nano_installation_guide.js index 6ad96800..52553a3c 100644 --- a/docs/readthedocs/source/_static/js/nano_installation_guide.js +++ b/docs/readthedocs/source/_static/js/nano_installation_guide.js @@ -1,149 +1,94 @@ -var inferences=["inferenceyes", "inferenceno"]; -var frameworks=["pytorch", "tensorflow"]; -var versions=["pytorch_110", "pytorch_111", "pytorch_112", "pytorch_113", "tf2_27", "tf2_28", "tf2_29", "tf2_210"]; -var releases=["stable", "nightly"]; +var frameworks = ["pytorch", "tensorflow"]; +var versions = ["pytorch_110", "pytorch_111", "pytorch_112", "pytorch_113", + "tensorflow_27", "tensorflow_28", "tensorflow_29", "tensorflow_210"]; +var intel_tensorflow_options = ["intel_tensorflow_yes", "intel_tensorflow_no"] +var inferences = ["inference_yes", "inference_no"]; +var releases = ["stable", "nightly"]; -var inference="inferenceyes"; -var framework="pytorch"; -var version="pytorch_113"; -var release="nightly"; +var framework = "pytorch"; +var version = "pytorch_113"; +var intel_tensorflow_option = "intel_tensorflow_yes" +var inference = "inference_yes"; +var release = "nightly"; function refresh_cmd(){ + $("#version").empty(); + $("#intel_tensorflow").remove(); + if(framework == "pytorch"){ + $("#version").append("PT Version\ + \ + \ + \ + "); + } + else if(framework == "tensorflow"){ + $("#version").append("TF Version\ + \ + \ + \ + "); + + $("#version").after("\ + Intel TensorFlow\ + \ + \ + "); + } + reset_color(frameworks); + reset_color(versions); + reset_color(intel_tensorflow_options); reset_color(inferences); reset_color(releases); set_color(framework); + set_color(version); + set_color(intel_tensorflow_option); set_color(inference); set_color(release); - var cmd="NA"; - - $("#version").empty(); - if(framework=="pytorch"){ - $("#version").append("Pytorch Version\ - \ - \ - \ - "); + // disable buttons for options that cannot be selected together + if (release == "stable"){ + disable(["intel_tensorflow_no"]) + } else { + enable(["intel_tensorflow_no"]) } - else if(framework=="tensorflow"){ - $("#version").append("Tensorflow Version\ - \ - \ - \ - "); - } - reset_color(versions); - set_color(version); - // if (framework=="pytorch"){ - // document.getElementById("cmd").style.whiteSpace = "normal"; - // } - // else{ - // document.getElementById('cmd').style.whiteSpace = "nowrap"; - // } - if(framework=="pytorch"){ - if(release=="stable"){ - if(inference=="inferenceyes"){ - if(version=="pytorch_110"){ - cmd="pip install bigdl-nano[pytorch_110,inference] -f https://software.intel.com/ipex-whl-stable"; - }else if(version=="pytorch_111"){ - cmd="pip install bigdl-nano[pytorch_111,inference]"; - }else if(version=="pytorch_112"){ - cmd="pip install bigdl-nano[pytorch_112,inference]"; - }else if(version=="pytorch_113"){ - cmd="pip install bigdl-nano[pytorch,inference]"; - } - }else if(inference="inferenceno"){ - if(version=="pytorch_110"){ - cmd="pip install bigdl-nano[pytorch_110] -f https://software.intel.com/ipex-whl-stable"; - }else if(version=="pytorch_111"){ - cmd="pip install bigdl-nano[pytorch_111]"; - }else if(version=="pytorch_112"){ - cmd="pip install bigdl-nano[pytorch_112]"; - }else if(version=="pytorch_113"){ - cmd="pip install bigdl-nano[pytorch]"; - } - } - }else if(release=="nightly"){ - if(inference=="inferenceyes"){ - if(version=="pytorch_110"){ - cmd="pip install --pre --upgrade bigdl-nano[pytorch_110,inference] -f https://software.intel.com/ipex-whl-stable"; - }else if(version=="pytorch_111"){ - cmd="pip install --pre --upgrade bigdl-nano[pytorch_111,inference]"; - }else if(version=="pytorch_112"){ - cmd="pip install --pre --upgrade bigdl-nano[pytorch_112,inference]"; - }else if(version=="pytorch_113"){ - cmd="pip install --pre --upgrade bigdl-nano[pytorch,inference]"; - } - }else if(inference="inferenceno"){ - if(version=="pytorch_110"){ - cmd="pip install --pre --upgrade bigdl-nano[pytorch_110] -f https://software.intel.com/ipex-whl-stable"; - }else if(version=="pytorch_111"){ - cmd="pip install --pre --upgrade bigdl-nano[pytorch_111]"; - }else if(version=="pytorch_112"){ - cmd="pip install --pre --upgrade bigdl-nano[pytorch_112]"; - }else if(version=="pytorch_113"){ - cmd="pip install --pre --upgrade bigdl-nano[pytorch]"; - } - } - } - }else if(framework="tensorflow"){ - if(inference=="inferenceyes"){ - if (version=="tf2_27"){ - if (release=="nightly"){ - cmd="pip install --pre --upgrade bigdl-nano[tensorflow_27,inference]"; - }else if(release=="stable"){ - cmd="pip install bigdl-nano[tensorflow_27,inference]"; - } - }else if(version=="tf2_28"){ - if (release=="nightly"){ - cmd="pip install --pre --upgrade bigdl-nano[tensorflow_28,inference]"; - }else if(release=="stable"){ - cmd="pip install bigdl-nano[tensorflow_28,inference]"; - } - }else if(version=="tf2_29"){ - if (release=="nightly"){ - cmd="pip install --pre --upgrade bigdl-nano[tensorflow,inference]"; - }else if(release=="stable"){ - cmd="pip install bigdl-nano[tensorflow,inference]"; - } - }else if(version=="tf2_210"){ - if (release=="nightly"){ - cmd="pip install --pre --upgrade bigdl-nano[tensorflow_210,inference]"; - }else if(release=="stable"){ - cmd="pip install bigdl-nano[tensorflow_210,inference]"; - } - } - }else if(inference=="inferenceno"){ - if(version=="tf2_27"){ - if(release=="nightly"){ - cmd="pip install --pre --upgrade bigdl-nano[tensorflow_27]"; - }else if(release=="stable"){ - cmd="pip install bigdl-nano[tensorflow_27]"; - } - }else if(version=="tf2_28"){ - if(release=="nightly"){ - cmd="pip install --pre --upgrade bigdl-nano[tensorflow_28]"; - }else if(release=="stable"){ - cmd="pip install bigdl-nano[tensorflow_28]"; - } - }else if(version=="tf2_29"){ - if(release=="nightly"){ - cmd="pip install --pre --upgrade bigdl-nano[tensorflow]"; - }else if(release=="stable"){ - cmd="pip install bigdl-nano[tensorflow]"; - } - }else if(version=="tf2_210"){ - if(release=="nightly"){ - cmd="pip install --pre --upgrade bigdl-nano[tensorflow_210]"; - }else if(release=="stable"){ - cmd="pip install bigdl-nano[tensorflow_210]"; - } - } - } - } + if (intel_tensorflow_option == "intel_tensorflow_no" && + framework == "tensorflow"){ + disable(["stable"]) + } else { + enable(["stable"]) + } + + // whether to include pre-release version + var cmd_pre = (release == "nightly") ? " --pre --upgrade" : ""; + + // decide on the bigdl-nano install option for framework + var cmd_options_framework = version; + + if (intel_tensorflow_option == "intel_tensorflow_no"){ + cmd_options_framework = "stock_" + cmd_options_framework; + } + // for default version + if (version == "pytorch_113"){ + cmd_options_framework = "pytorch"; + } else if (version == "tensorflow_29" && intel_tensorflow_option == "intel_tensorflow_yes"){ + cmd_options_framework = "tensorflow"; + } + + // decide on the bigdl-nano install option for including inference or not + var cmd_options_inference = (inference == "inference_yes") ? ",inference" : ""; + + // other options needed at the end of the installation command + var cmd_other = ""; + if (version == "pytorch_110"){ + cmd_other = " -f https://software.intel.com/ipex-whl-stable"; + } + + var cmd = "pip install" + cmd_pre + " bigdl-nano[" + cmd_options_framework + + cmd_options_inference + "]" + cmd_other; + $("#cmd").html(cmd); } @@ -183,27 +128,29 @@ function enable(list){ } //when clicked a button, update variables -$(document).on('click',"button",function(){ +$(document).on('click',".install_option_button",function(){ var id = $(this).attr("id"); - if (frameworks.indexOf(id)>=0){ - framework=id; - if (framework=="tensorflow"){ - version="tf2_29"; + if (frameworks.includes(id)){ + framework = id; + if (framework == "tensorflow"){ + version = "tensorflow_29"; }else{ version="pytorch_113"; } } - else if (releases.indexOf(id)>=0){ - release=id; + else if (versions.includes(id)){ + version = id; } - else if (inferences.indexOf(id)>=0){ - inference=id; + else if (intel_tensorflow_options.includes(id)){ + intel_tensorflow_option = id; } - else if (versions.indexOf(id)>=0){ - version=id; + else if (inferences.includes(id)){ + inference = id; + } + else if (releases.includes(id)){ + release = id; } - refresh_cmd(); }) @@ -221,6 +168,6 @@ $(document).on({ $(this).css("color","var(--pst-color-text-base)"); } } -}, "button"); +}, ".install_option_button"); refresh_cmd(); diff --git a/docs/readthedocs/source/doc/Nano/Overview/install.md b/docs/readthedocs/source/doc/Nano/Overview/install.md index 686266fc..f67d1cbb 100644 --- a/docs/readthedocs/source/doc/Nano/Overview/install.md +++ b/docs/readthedocs/source/doc/Nano/Overview/install.md @@ -12,28 +12,27 @@ You can select bigdl-nano along with some dependencies specific to PyTorch or Te FrameWork - - + + - + Version - - - - + + + + - Inference Optimization - - - + Inference Opt + + Release - - + + - + Install CMD NA