Commit graph

71 commits

Author SHA1 Message Date
Shengsheng Huang
1ae519ec69
add langchain-chatchat quickstart (#10652) 2024-04-03 19:23:09 +08:00
Shengsheng Huang
45437ddc9a
update indexes, move some sections in coding quickstart to webui (#10651) 2024-04-03 18:18:49 +08:00
Yuwen Hu
c182acef3f
[Doc] Update IPEX-LLM Index Page (#10534)
* Update readthedocs readme before Latest Update

* Update before quick start section in index page

* Update quickstart section

* Further updates for Code Example

* Small fix

* Small fix

* Fix migration guide style
2024-03-25 18:43:32 +08:00
Yuwen Hu
e0ea7b8244
[Doc] IPEX-LLM Doc Layout Update (#10532)
* Fix navigation bar to 1

* Remove unnecessary python api

* Fixed failed langchain native api doc

* Change index page layout

* Update quicklink for IPEX-LLM

* Simplify toc and add bigdl-llm migration guide

* Update readthedocs readme

* Add missing index link for bigdl-llm migration guide

* Update logo image and repo link

* Update copyright

* Small fix

* Update copyright

* Update top nav bar

* Small fix
2024-03-25 16:23:56 +08:00
Kai Huang
92ee2077b3 Update Linux Quickstart (#10499)
* fix quick start

* update toc

* expose docker
2024-03-21 20:13:21 +08:00
Ruonan Wang
8d0ea1b9b3 LLM: add initial QuickStart for linux cpp usage (#10418)
* add first version

* update content and add link

* --amend

* update based on new usage

* update usage based on new pr

* temp save

* basic stable version

* change to backend
2024-03-21 17:35:58 +08:00
WeiguangHan
db00e79cdf LLM: add user guide for benchmarking (#10284)
* add user guide for benchmarking

* change the name and place of the benchmark user guide

* resolve some comments

* resolve new comments

* modify some typo

* resolve some new comments

* modify some descriptions
2024-03-07 18:50:29 +08:00
Yuwen Hu
566e9bbb36 [LLM Doc] Restructure (#10322)
* Add quick link guide to sidebar

* Add QuickStart to TOC

* Update quick links in main page

* Hide some section in More for top nav bar

* Resturct FAQ sections

* Small fix
2024-03-05 14:35:55 +08:00
binbin Deng
4b92235bdb LLM: add initial FAQ page (#10055) 2024-02-01 09:43:39 +08:00
Xin Qiu
0f9a440b06 doc for Multi gpu selection (#9414) 2023-11-20 09:25:58 +08:00
binbin Deng
7e96d3e79a LLM: improve gpu supports key feature doc page (#9212) 2023-10-19 18:40:48 +08:00
binbin Deng
760183bac6 LLM: update key feature and installation page of document (#9068) 2023-09-27 15:44:34 +08:00
Yuwen Hu
cf6a620bae [LLM] BigDL-LLM Documentation Initial Version (#8833)
* Change order of LLM in header

* Some updates to footer

* Add BigDL-LLM index page and basic file structure

* Update index page for key features

* Add initial content for BigDL-LLM in 5 mins

* Improvement to footnote

* Add initial contents based on current contents we have

* Add initial quick links

* Small fix

* Rename file

* Hide cli section for now and change model supports to examples

* Hugging Face format -> Hugging Face transformers format

* Add placeholder for GPU supports

* Add GPU related content structure

* Add cpu/gpu installation initial contents

* Add initial contents for GPU supports

* Add image link to LLM index page

* Hide tips and known issues for now

* Small fix

* Update based on comments

* Small fix

* Add notes for Python 3.9

* Add placehoder optimize model & reveal CLI; small revision

* examples add gpu part

* Hide CLI part again for first version of merging

* add keyfeatures-optimize_model part (#1)

* change gif link to the ones hosted on github

* Small fix

---------

Co-authored-by: plusbang <binbin1.deng@intel.com>
Co-authored-by: binbin Deng <108676127+plusbang@users.noreply.github.com>
2023-09-06 15:38:45 +08:00
Kai Huang
1b65288bdb Add api doc for LLM (#8605)
* api doc initial

* update desc
2023-08-08 18:17:16 +08:00
Heyang Sun
5ad5ac5356 LightGBM Spark Readthedocs (#8381)
* LightGBM Spark Readthedocs

* Update secure_lightgbm_on_spark.md

* Update secure_lightgbm_on_spark.md

* Update secure_lightgbm_on_spark.md

* refine

* Update secure_lightgbm_on_spark.md

* add html link

* Update secure_lightgbm_on_spark.md

* Update secure_lightgbm_on_spark.md

* add in yaml
2023-06-26 13:14:40 +08:00
Pingchuan Ma (Henry)
30367f5eb1 [Nano] Add how-to-guide for pytorch async pipeline (#8146)
* add how-to-guide for pytorch async pipeline

* revise introduction

* resolve image issues
2023-05-06 22:15:42 +08:00
Pingchuan Ma (Henry)
c6eccbfcc2 [Nano] add pt dgpu inference how-to-guide (#8026)
* docs for arc dgpu how-to-guide

* minor adjustment + system info

* minor adjustment for appearance

* fix bugs

* add system info

* fix syntax errors

* adjust docs according to comments

* final adjustment

* delete gpu workflow testing
2023-04-12 19:18:16 +08:00
Junwei Deng
2daaa6f7de Nano: TF multi process how-to for customized training loop (#8006)
* add how-to guide

* add overview

* fix doc

* fix pep8

* update the notebook
2023-04-07 17:19:47 +08:00
Junwei Deng
a6f96521af Chronos: AIOps User Guide (#7960)
* add aiops doc

* add image

* fix typo
2023-03-31 10:15:00 +08:00
Qiyuan Gong
bcfcb3f12b [PPML] Alibaba ECS Occlum CN Develop guide (#7297)
* Alibaba ECS Occlum CN Develop guide with Occlum
* Refine examples and style based on comments
* Add to readthedocs
2023-02-17 14:06:41 +08:00
Yuwen Hu
6960c87b54 [Nano] Revise outdated info in PyTorch Inference how-to guides (#7453)
* Change order of PyTorch Inference how-to guides order

* Revise accelerate_pytorch_inference_jit_ipex.ipynb

* Revise accelerat_pytorch_inference_onnx.ipynb

* Revise accelerate_pytorch_inference_openvino.ipynb

* Revise inference_optimizer_optimize.ipynb

* Revise multi_instance_pytorch_inference.ipynb

* Revise pytorch_context_manager.ipynb

* Revise pytorch_save_and_load_ipex.ipynb and other small fixes

* Revise pytorch_save_and_load_jit.ipynb and other small fixes

* Revise pytorch_save_and_load_onnx.ipynb and other small fixese

* Revise pytorch_save_and_load_openvino.ipynb

* Revise quantize_pytorch_inference_inc.ipynb and other small fixes

* Revise quantize_pytorch_inference_pot.ipynb and other small fixes

* Fix failed links in the index page

* Small fixes

* Update based on comments
2023-02-09 17:50:50 +08:00
Yishuo Wang
f4700422e1 Nano: add OS support table (#7429) 2023-02-06 18:01:31 +08:00
Yuwen Hu
c31136df0b [Nano] Improve How-to Guides Navigations (#7396)
* Remove deprecated option enable_auto_doc_ref for recommonmark

* Add first level navigation structure for Nano how-to guides

* Update navigation for How-to Training part

* Update navigation for How-to Inference part

* Update navigation for How-to Preprocessing/Install part and other small fixes

* Fix wrong link path caused by position changes of how-to install related guides

* Small fix
2023-02-03 09:37:10 +08:00
Yuwen Hu
c7674f52b2 [Nano] Add how-to guide for TensorFlow Keras inference using bf16 mixed precision (#7337)
* Add basic structure for tf bf16 infer how-to guide

* Add how-to use BFloat16 mixed precision for TensorFlow Keras inference

* Small fixes

* Add instruction requires box

* Add outputs to show inference time diff

* Small fixes regarding hardware requirements and others

* Update based on comments

* Small fixes

* Small fixes
2023-02-01 13:33:54 +08:00
Junwei Deng
08a556239c Chronos: add how to guide for forecaster.optimize (#7387) 2023-02-01 11:39:27 +08:00
Sirui Tao
3543a58723 [Nano] How-to Guide: Inference via Openvino on Intel GPUs (#7212)
* add openvino gpu inference guide

* enable online doc for how-to

* fix

* fix layout error

* update w.r.t. comments

* fix

* fix

* fix error
2023-01-12 09:31:12 +08:00
Henry Ma
2858a1b5bf [Nano] Add how-to-guide of load/save API for tensorflow inference (#7180)
* 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
2023-01-10 20:15:49 +08:00
Sirui Tao
d950992b91 [Nano] How-To Guides: Accelerate PyTorch Training with IPEX & Multi-instance & BF16 & Channels last (#7035)
* add pytorch training ipex guide

* add pytorch training multi-instance guide

* add bf16 guide

* small changes of presentation

* add channels last guide

* remove validation loader

* hide code block

* update based on comments

* add guide for reference

* update guides w.r.t. comments
2023-01-10 13:14:47 +08:00
Hu, Zhaojie
6ca8f8567f Chronos: Add how to guide for export_jit (#7194)
* add how to guide for export_jit

* update

* update

* update code example
2023-01-09 14:05:49 +08:00
Yuwen Hu
5e9ef7b553 [Nano] Add a generalized how-to guide for accelerate PyTorch cv data process pipeline (#7125)
* 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
2023-01-05 18:07:10 +08:00
Yuwen Hu
bfca337d09 [Nano] Add how-to guide for TensorFlow Keras training using bf16 (#7169)
* 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
2023-01-05 17:59:43 +08:00
Henry Ma
18ae409b7c [Nano] add how-to-guide for tensorflow inference by onnxruntime and openvino (#7149)
* 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
2023-01-04 23:43:48 +08:00
Yishuo Wang
ab9a3b69fb Nano: Add CUDA patch key feature (#7089) 2023-01-04 10:53:27 +08:00
Junwei Deng
56e94eda59 Chronos: add forecaster alg choose guide and some cleaning for how to guide (#7139)
* fix format

* fix

* update

* update
2023-01-03 15:00:27 +08:00
Kai Huang
264451c6bd Merge Orca quick starts and how to (#7133)
* add tf2 to howto

* update tf2

* remove

* modify sidebar

* remove quickstart

* minor
2022-12-30 16:05:15 +08:00
Yuwen Hu
37b0c6fa50 [Nano] How-To Guides: Convert to TorchNano & use @nano decorator (#5984)
* 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
2022-12-26 15:36:53 +08:00
Ruonan Wang
14cf4aff72 Nano: Troubshooting guide for BigDL-Nano (#6910)
* add troubshooting guide

* add more cases

* update style

* update

* update style

* update two cases

* update

* add two issue
2022-12-26 10:02:44 +08:00
Ruonan Wang
b3feb53c4a Nano: add key feature and how to guide for context manager (#6897)
* 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
2022-12-13 16:57:52 +08:00
Yishuo Wang
664dfbe7ef Nano: Add key feature and how to guide for multi-instance inference (#6901) 2022-12-13 14:18:26 +08:00
Qiyuan Gong
3571247d65 [PPML] Attestation basic (#6778)
* Add attestation basic doc to readthedoc
2022-11-28 13:26:52 +08:00
WangJun
bf5ccae4ef [Nano] add how to guide save and load jit, ipex, onnx, openvino (#6659)
* 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
2022-11-25 15:47:15 +08:00
Qiyuan Gong
621168ce2e [PPML] Move dev guide to tutorial (#6765)
* Move dev guide to tutorial & examples.
2022-11-25 15:02:11 +08:00
binbin Deng
df775d172e Chronos: benchmark tool user guide (#6668) 2022-11-25 11:25:34 +08:00
Cengguang Zhang
ca3b088522 Doc: update sidebar and quickstarts order. (#6743)
* doc: update sidebar and quickstarts order.

* fix: adjust quickstart order.

* fix: fix typo.

* fix: fix typo.
2022-11-23 18:57:11 +08:00
Junwei Deng
022d8d661c Chronos: add a how to guide to help users replay their forecaster with pre/post processing in production env (#6258)
* add notebook

* add updates

* rm output

* fix link

* add fix

* fix index
2022-11-17 19:28:34 +08:00
Kai Huang
c80bb4b876 Expose k8s tutorial to docs (#6596) 2022-11-14 20:35:38 +08:00
Ruonan Wang
dbce8f13e0 Chronos : How to preprocess my data guide (#6446)
* add introduction

* finish basic version

* update nblink

* update based on comments

* update css
2022-11-11 16:30:15 +08:00
Juntao_Luo
4f3c27bde0 Chronos: upload prediction how-to-guide. (#5959)
* 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>
2022-11-09 09:20:19 +08:00
David smurf
4403c7727f Chronos: forecaster save/load how-to guide (#5684)
* 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>
2022-11-08 21:49:23 +08:00
Qiyuan Gong
0a49cd03bf [PPML] Reorg Readthedoc tutorial & menu (#6476)
* Change User Guide to Introduction
* Add Installation
* Refine toc and examples
* Refine title
* Add FAQs for Installation
2022-11-08 16:26:59 +08:00