ipex-llm/docs/readthedocs/source/doc/PythonAPI/LLM/transformers.rst
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

92 lines
2.2 KiB
ReStructuredText

BigDL-LLM `transformers`-style API
=====================
llm.transformers.model
---------------------------
.. autoclass:: bigdl.llm.transformers.model.AutoModelForCausalLM
:members:
:undoc-members:
:show-inheritance:
.. automethod:: from_pretrained
.. automethod:: load_convert
.. automethod:: load_low_bit
.. autoclass:: bigdl.llm.transformers.model.AutoModel
:members:
:undoc-members:
:show-inheritance:
.. automethod:: from_pretrained
.. automethod:: load_convert
.. automethod:: load_low_bit
.. autoclass:: bigdl.llm.transformers.model.AutoModelForSpeechSeq2Seq
:members:
:undoc-members:
:show-inheritance:
.. automethod:: from_pretrained
.. automethod:: load_convert
.. automethod:: load_low_bit
.. autoclass:: bigdl.llm.transformers.model.AutoModelForSeq2SeqLM
:members:
:undoc-members:
:show-inheritance:
.. automethod:: from_pretrained
.. automethod:: load_convert
.. automethod:: load_low_bit
llm.transformers.modelling_bigdl
----------------------------------------
.. autoclass:: bigdl.llm.transformers.modelling_bigdl.LlamaForCausalLM
:members:
:undoc-members:
:show-inheritance:
:exclude-members: GGML_Model, GGML_Module, HF_Class
.. automethod:: from_pretrained
.. autoclass:: bigdl.llm.transformers.modelling_bigdl.ChatGLMForCausalLM
:members:
:undoc-members:
:show-inheritance:
:exclude-members: GGML_Model, GGML_Module, HF_Class
.. automethod:: from_pretrained
.. autoclass:: bigdl.llm.transformers.modelling_bigdl.GptneoxForCausalLM
:members:
:undoc-members:
:show-inheritance:
:exclude-members: GGML_Model, GGML_Module, HF_Class
.. automethod:: from_pretrained
.. autoclass:: bigdl.llm.transformers.modelling_bigdl.BloomForCausalLM
:members:
:undoc-members:
:show-inheritance:
:exclude-members: GGML_Model, GGML_Module, HF_Class
.. automethod:: from_pretrained
.. autoclass:: bigdl.llm.transformers.modelling_bigdl.StarcoderForCausalLM
:members:
:undoc-members:
:show-inheritance:
:exclude-members: GGML_Model, GGML_Module, HF_Class
.. automethod:: from_pretrained