* Small fixes to (un)patch_tensorflow api doc and make its import path in api doc show as the recommended one
* Add api doc for nano_bf16 decorator
* Move api doc for bigdl.nano.tf.keras.InferenceOptimizer out of bigdl.nano.tf.keras to make it more clear
* Fix python styles
* Fix path in Nano PyTorch API docs
* Add api doc for bigdl.nano.pytorch.patching.patch_encryption
* Add a note box for bigdl.nano.pytorch.patching.patch_encryption api doc
* Fix Python style again
* Fix path in Nano HPO API doc and other small fixes
* feat(docs): add load/save onnx and opnevino model for tensorflow
* fix bugs after previewing
* fix order issues of insertion for toc.yml
* change link title for tensorflow
* Restyle blockquote elements in web
* Add a generalized how-to section for preprocessing, including the data process accelerastion for PyTorch
* Small fix
* Update based on comments and small typo fixes
* Small fixes
* Add basic doc structure for bf16 tf training how-to guide, and change the incorrect order of tf inference guides in toc
* Add how-to guide for tf bf16 training
* Add warning box for tf bf16 hardware limitations
* Add a print message to show the default policy of model after unpatch
* Small fixes
* Small github action fixes for tf bf16 training how-to guide
* diable action test for tf bf16 train for now, due to the core dumped problem on platforms without AVX512
* Updated based on comments
* Feat(docs): add how-to-guide for tensorflow inference by onnxruntime and openvino
* fix bugs for index.rst
* revise according to PR comments
* revise minor parts according to PR comments
* revise bugs according to PR comments
* update howto guide for optimizer
* update export model
* update typo
* update based on comments
* fix bug of get_best_model without validation data
* update ut
* update
* update
* fix 600s
* fix
* Add more key features regarding TorchNano and @nano for pytorch training
* Small fixes
* Remove the Overview title
* Add auto_lr in related notes
* Update based on comments
* Add how to guide: How to convert your PyTorch code to use TorchNano for training acceleration
* Small nano how-to index format update for openvino inference
* Update based on comments
* Updated based on comments
* Add how-to guide: How to wrap a PyTorch training loop through @nano decorator
* Add reference to TorchNano guide in @nano guide
* Some small fixes and updates
* Small typo fix: bulit -> built
* Updates based on comments
* Remove validation dataloader based on comments
* Order change of two guides
* Update based on comments
* upddate installation
* update
* update runtime acceleration
* update link in rst
* add bf16 quantization and optimize()
* update based on comment
* update
* update based on comment
* add key feature and how to guide for context manager
* update key feature for multi models
* update based on comment
* update
* update based on comments
* update
* update
* add how to guide:
* acclerate with jit_ipex
* save and load jit, ipex, onnx, openvino
* add these five above .nblink files
;
* add index of sl files
* clear all the output & fix the bug of title
* remove extra blank indent
* format the jupter with prettier
* fix the bug of error words
* add blank line before unorder list
* * remove the normal inference in accelerate using jit/ipex;
* add note to example why we should pass in the orginal model to get the optimized one in sl ipex
* fix:new pip install shell cmd & indent improve
* add optimizer.py
* fix style
* set version for mypy
* add thread control for quantize, support openvino pot
* update optimizer
* fix typo
* update workflow
* temp commit
* modify ut
* refactor optimizer
* rebase, update based on comments
* add nano notebook example for openvino ir
* add basic example for openvino model inference
* add notebook example for sync inference and async inference
* add notebook to documentation
* update explanation for async api
* try to fix code snip
* fix code snip
* simplify async api explanation
* simplify async api explanation
* adapt new theme
* Upload:how_to_use_forecaster_to_predict_future_data how to guide.
* Update: update hyperlink in notebook.
* Update: update how-to-guide
* Update: update guide with pure prediction.
* tmp save
* test
* update how to predict
* make cell hidden
* update
* update toc
* update based on coments
Co-authored-by: ruoan1.wang <ruonan1.wang@intel.com>
* how to save and load forecaseter
* add doc of forecaster save and load
* update save and load notebook
* update notebook
* update link
* fix typo
Co-authored-by: ruoan1.wang <ruonan1.wang@intel.com>
* feat: update orca-in-5-minutes to tf2 estimator.
* fix: fix code and tensorflow version.
* fix: fix typo.
* fix: add config in estiamtor construction.
* feat: add random split to dataframe.
* fix: fix typo.
* feat: add test data in fit.
* fix: update link branch to main
* fix: fix typo.
* Add sphinxcontribute-mermaid extension
* Add manual link for mermaid.js
* Load mermaid.js before require.js to avoid errors
* Update documentation guide for the usage of mermaid diagram in our doc
* Resolve error caused by double loaded mermaid.js
* Small fixes
* Small fix based on comments
* Revise toc tree & add draft version for document guide
* Add more contents and revise documentation guide
* Rename new file for documentation guide
* Add some new contents and try to change html tables to plain text tables for generated styles
* Change back to html table with specified css
* Add some new contents and small revision
* Revise contributor index page
* Minor typo fixes for landing page quicklinks
* Revise based on comments
* Add rst card components and small revisions
* create how-to guides for export model files to onnx/openvino
* add how to export onnx files
* add to doc
* hide the training process
* fix
* add how to export openvino files
* fix onnx
* fix nblink
* fix onnx
* change import
* fix onnx
* update some descriptions
* update yml file
* Remove manually-added bold style for titles in [User guide] section
* Fix failed relative links in windows user guide
* Remove manually-added bold style for titles in [Orca] section
* Fix failed relative links & title bold fix in Nano 5 min
* Remove manually-added bold style for titles in [Nano] section
* Remove manually-added bold style for titles in [DLlib] section
* Remove manually-added bold style for titles in [Chronos] section
* Remove manually-added bold style for titles in Developer guide
* Remove manually-added bold title style for all other not-included md files in docs/readthedocs/source/doc folder
* Fix based on comments
* refactor toc
* refactor toc
* Change to pydata-sphinx-theme and update packages requirement list for ReadtheDocs
* Remove customized css for old theme
* Add index page to each top bar section and limit dropdown maximum to be 4
* Use js to change 'More' to 'Libraries'
* Add custom.css to conf.py for further css changes
* Add BigDL logo and search bar
* refactor toc
* refactor toc and add overview
* refactor toc and add overview
* refactor toc and add overview
* refactor get started
* add paper and video section
* add videos
* add grid columns in landing page
* add document roadmap to index
* reapply search bar and github icon commit
* reorg orca and chronos sections
* Test: weaken ads by js
* update: change left attrbute
* update: add comments
* update: change opacity to 0.7
* Remove useless theme template override for old theme
* Add sidebar releases component in the home page
* Remove sidebar search and restore top nav search button
* Add BigDL handouts
* Add back to homepage button to pages except from the home page
* Update releases contents & styles in left sidebar
* Add version badge to the top bar
* Test: weaken ads by js
* update: add comments
* remove landing page contents
* rfix chronos install
* refactor install
* refactor chronos section titles
* refactor nano index
* change chronos landing
* revise chronos landing page
* add document navigator to nano landing page
* revise install landing page
* Improve css of versions in sidebar
* Make handouts image pointing to a page in new tab
* add win guide to install
* add dliib installation
* revise title bar
* rename index files
* add index page for user guide
* add dllib and orca API
* update user guide landing page
* refactor side bar
* Remove extra style configuration of card components & make different card usage consistent
* Remove extra styles for Nano how-to guides
* Remove extra styles for Chronos how-to guides
* Remove dark mode for now
* Update index page description
* Add decision tree for choosing BigDL libraries in index page
* add dllib models api, revise core layers formats
* Change primary & info color in light mode
* Restyle card components
* Restructure Chronos landing page
* Update card style
* Update BigDL library selection decision tree
* Fix failed Chronos tutorials filter
* refactor PPML documents
* refactor and add friesian documents
* add friesian arch diagram
* update landing pages and fill key features guide index page
* Restyle link card component
* Style video frames in PPML sections
* Adjust Nano landing page
* put api docs to the last in index for convinience
* Make badge horizontal padding smaller & small changes
* Change the second letter of all header titles to be small capitalizd
* Small changes on Chronos index page
* Revise decision tree to make it smaller
* Update: try to change the position of ads.
* Bugfix: deleted nonexist file config
* Update: update ad JS/CSS/config
* Update: change ad.
* Update: delete my template and change files.
* Update: change chronos installation table color.
* Update: change table font color to --pst-color-primary-text
* Remove old contents in landing page sidebar
* Restyle badge for usage in card footer again
* Add quicklinks template on landing page sidebar
* add quick links
* Add scala logo
* move tf, pytorch out of the link
* change orca key features cards
* fix typo
* fix a mistake in wording
* Restyle badge for card footer
* Update decision tree
* Remove useless html templates
* add more api docs and update tutorials in dllib
* update chronos install using new style
* merge changes in nano doc from master
* fix quickstart links in sidebar quicklinks
* Make tables responsive
* Fix overflow in api doc
* Fix list indents problems in [User guide] section
* Further fixes to nested bullets contents in [User Guide] section
* Fix strange title in Nano 5-min doc
* Fix list indent problems in [DLlib] section
* Fix misnumbered list problems and other small fixes for [Chronos] section
* Fix list indent problems and other small fixes for [Friesian] section
* Fix list indent problem and other small fixes for [PPML] section
* Fix list indent problem for developer guide
* Fix list indent problem for [Cluster Serving] section
* fix dllib links
* Fix wrong relative link in section landing page
Co-authored-by: Yuwen Hu <yuwen.hu@intel.com>
Co-authored-by: Juntao Luo <1072087358@qq.com>
* Add api docs for bigdl.nano.tf.keras.layers.Embedding and bigdl.nano.tf.optimizers.SparseAdam
* Update API document link in related how-to guide
* Remove non-related parameter explanation for Embedding
* Add param explanation for kwargs in for Embedding, and small revision
* Small fix
* Add basic guides structure of Training - TensorFlow
* Add how-to guides: How to accelerate a TensorFlow Keras application on training workloads through multiple instances
* Change import order and add pip install for tensorflow-dataset
* Diable other nano tests for now
* Add github action tests for how-to guides Tensorflow training
* Use jupyter nbconvert to test notebooks for training tensorflow instead to avoid errors
* Add how-to guide: How to optimize your model with a sparse Embedding layer and SparseAdam optimizer
* Enable other nano tests again
* Small Revision: fix typos
* Small Revision: refactor some sentences
* Revision: refactor contents based on comments
* Add How-to guides: How to choose the number of processes for multi-instance training
* Small Revision: fix typos and refactor some sentences
* Make timeout time for github action longer for TensorFlow, 600s->700s
* Rearrange file structure for PyTorch Inference for docs and add titles for PyTorch-Lightning Training
* Add How-to guide: How to accelerate a PyTorch-Lightning application on training workloads through Intel® Extension for PyTorch*
* Add how-to guide: How to accelerate a PyTorch-Lightning application on training workloads through multiple instances
* Revise: remove '-' in 'PyTorch-Lightning' and some other changes
* Add How-to guides: How to use the channels last memory format in your PyTorch Lightning application for training
* Add how-to guide: Use BFloat16 Mixed Precision for PyTorch Lightning Training
* Add How-to guide: How to accelerate a computer vision data processing pipeline
* Small Revision: change comments in several code cells
* Disable other nano tests temporarily
* Add github action tests for Nano Training PyTorch Lightning tests
* Enable other nano tests again
* Small revisions: typos and explanation texts changes
* Revise: update based on comments
* Create doc tree index for Nano How-to Guides
* Add How to guide for PyTorch Inference using ONNXRuntime
* Add How to guide for PyTorch Inference using OpenVINO
* Update How to guide for PyTorch Inference using OpenVINO/ONNXRuntime
* Change current notebook to md and revise contents to be more concentrated
* Add How-to Guide: Install BigDL-Nano in Google Colab (need further update)
* Revise words in How-to Guide for PyTorch Inference using OpenVINO/ONNXRuntime
* Add How-To Guide: Quantize PyTorch Model for Inference using Intel Neural Compressor
* Add How-To Guide: Quantize PyTorch Model for Inference using Post-training Quantization Tools
* Add API doc links and small revision
* Test: syncronization through marks in py files
* Test: syncronization through notebook with cells hidden from rendering in doc
* Remove test commits for runnable example <-> guides synchronization
* Enable rendering notebook from location out of sphinx source root
* Update guide "How to accelerate a PyTorch inference pipeline through OpenVINO" to notebook under python folder
* Update guide "How to quantize your PyTorch model for inference using Intel Neural Compressor" to notebook under python folder
* Fix bug that markdown will be ignored inside html tags for nbconvert, and notebook revise
* Update guide 'How to quantize your PyTorch model for inference using Post-training Optimization Tools' to notebook under python folder
* Small updates to index and current guides
* Revision based on Junwei's comments
* Update how-to guides: How to install BigDL-Nano in Google Colab, and update index page
* Small typo fix
* Update:installation panel enhancement
Left a bug to fix and install CMD to revise.
* Bugfix: Fixed a bug when using Firefox browser to use the install guide form.
Fixed the bug that the table's background color may be changed by mistake on Firefox browser.
* Update: update panel as comment required.
* Bugfix: fixed a bug in js file that will show wrong cmd when clicking 'windows' or 'docker'.
* Bugfix: fixed the bug that 'cmd' shows incorrectly when clicking 'prophet' and 'ARIMA'.
* Add extension nbsphinx-link: link notebook out of the sphinx root folder to the sphinx project
* Link Notebook custom.ipynb directly from python folder to the sphinx project
* Link Notebook seq_and_func.ipynb directly from python folder to the sphinx project
* Small title fix
* Make interactive graphs visible in readthedocs webpage for seq_and_func.ipynb
* Regenerate outputs for custom.ipynb and remove parts of them
* add how_to_tune_a_forecaster_model notebook
* modify step1: data preparation
* update based how to train
* modify a bug of summary
* update based on comment
* move to howto
* fix typo
* add file
* update based on comments
* rename the tile
* Update open in colab button from HTML-style hyperlinks to markdown image with link for notebooks in readthedocs folder
* Update "Open in Colab" button for notebooks under python folder with markdown image with link
* how to train forecaster
* add a notebook
* add new notebook
* add index
* fix colab link
* change content
Co-authored-by: Xinyi Zhang <xinyi1.zhang@intel.com>
Co-authored-by: theaperdeng <theaperdeng@outlook.com>
* docs: add save and load model docs.
* fix: update code style.
* fix: update code style.
* fix: fix typo and modify wording.
* docs: add save model example to notebook.
* fix: fix typo.
* Update chronos_installation_guide.css
* Update chronos_installation_guide.js
* Update chronos.md
* Change border color
* Deleted test text in '2. Install' title
I changed the title in last commit to check if my build in readthedoc web works fine. Now I delete it.
* Update button css selector
Revised the button selector to avoid influencing other buttons' style on the web.
* Update #cmd height
* Update as pull-request comment required.
1, disable other options when users choose windows, and guide users to https://bigdl.readthedocs.io/en/latest/doc/Chronos/Overview/windows_guide.html in "Install CMD"
2, guide users to https://bigdl.readthedocs.io/en/latest/doc/Chronos/Overview/chronos.html#tensorflow-backend in "Install CMD" when tensorflow is chosen.
3, guide users to https://github.com/intel-analytics/BigDL/tree/main/docker/chronos-nightly in "install CMD" when docker is chosen.
* Update css file to meet the comment requirements
Make the disabled items' background darker to have a better vis experience.
Have a larger fontsize.
* Update js file to meet the comment requirement.
Make the disabled items' background darker to have a better vis experience.
* Update border css settings.
Changed table border settings since last version looks not good.
* Change pmdarima to ARIMA
* Update visuals.
The button now has a hovering style, indicating the user that it can be clicked.
* Add tutorial notebook
* Add md
* Test on readthedocs
* Fix markdown
* fix md
* update notebooks
* update requirements version in doc
* update
* add and update tutorial
* add unit test for tensorflow tutorial
* reduce test time
* reduce test time
* update shell
* update action
* Update tutorial
* reduce ut time
* reduce ut time
* reduce ut time
* reduce ut time
* reduce ut time
* Update
* Fix shell
* update
* update
* rollback requirements
* Update
* Update
Co-authored-by: pinggao187 <ping.gao3@pactera.com>
