e0ea7b8244
* 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
164 lines
5 KiB
ReStructuredText
164 lines
5 KiB
ReStructuredText
IPEX-LLM LangChain API
|
|
=====================
|
|
|
|
LLM Wrapper of LangChain
|
|
----------------------------------------
|
|
|
|
Hugging Face ``transformers`` Format
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
IPEX-LLM provides ``TransformersLLM`` and ``TransformersPipelineLLM``, which implement the standard interface of LLM wrapper of LangChain.
|
|
|
|
.. tabs::
|
|
|
|
.. tab:: AutoModel
|
|
|
|
.. automodule:: ipex_llm.langchain.llms.transformersllm
|
|
:members:
|
|
:undoc-members:
|
|
:show-inheritance:
|
|
:exclude-members: model_id, model_kwargs, model, tokenizer, streaming, Config
|
|
|
|
.. tab:: pipeline
|
|
|
|
.. automodule:: ipex_llm.langchain.llms.transformerspipelinellm
|
|
:members:
|
|
:undoc-members:
|
|
:show-inheritance:
|
|
:exclude-members: pipeline, model_id, model_kwargs, pipeline_kwargs, Config
|
|
|
|
|
|
Native Model
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
For ``llama``/``chatglm``/``bloom``/``gptneox``/``starcoder`` model families, you could also use the following LLM wrappers with the native (cpp) implementation for maximum performance.
|
|
|
|
.. tabs::
|
|
|
|
.. tab:: Llama
|
|
|
|
.. autoclass:: ipex_llm.langchain.llms.LlamaLLM
|
|
:members:
|
|
:undoc-members:
|
|
:show-inheritance:
|
|
:exclude-members: ggml_model, ggml_module, client, model_path, kwargs
|
|
|
|
.. automethod:: validate_environment
|
|
.. automethod:: stream
|
|
.. automethod:: get_num_tokens
|
|
|
|
.. tab:: ChatGLM
|
|
|
|
.. autoclass:: ipex_llm.langchain.llms.ChatGLMLLM
|
|
:members:
|
|
:undoc-members:
|
|
:show-inheritance:
|
|
:exclude-members: ggml_model, ggml_module, client, model_path, kwargs
|
|
|
|
.. automethod:: validate_environment
|
|
.. automethod:: stream
|
|
.. automethod:: get_num_tokens
|
|
|
|
.. tab:: Bloom
|
|
|
|
.. autoclass:: ipex_llm.langchain.llms.BloomLLM
|
|
:members:
|
|
:undoc-members:
|
|
:show-inheritance:
|
|
:exclude-members: ggml_model, ggml_module, client, model_path, kwargs
|
|
|
|
.. automethod:: validate_environment
|
|
.. automethod:: stream
|
|
.. automethod:: get_num_tokens
|
|
|
|
.. tab:: Gptneox
|
|
|
|
.. autoclass:: ipex_llm.langchain.llms.GptneoxLLM
|
|
:members:
|
|
:undoc-members:
|
|
:show-inheritance:
|
|
:exclude-members: ggml_model, ggml_module, client, model_path, kwargs
|
|
|
|
.. automethod:: validate_environment
|
|
.. automethod:: stream
|
|
.. automethod:: get_num_tokens
|
|
|
|
.. tab:: Starcoder
|
|
|
|
.. autoclass:: ipex_llm.langchain.llms.StarcoderLLM
|
|
:members:
|
|
:undoc-members:
|
|
:show-inheritance:
|
|
:exclude-members: ggml_model, ggml_module, client, model_path, kwargs
|
|
|
|
.. automethod:: validate_environment
|
|
.. automethod:: stream
|
|
.. automethod:: get_num_tokens
|
|
|
|
|
|
Embeddings Wrapper of LangChain
|
|
----------------------------------------
|
|
|
|
Hugging Face ``transformers`` AutoModel
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. automodule:: ipex_llm.langchain.embeddings.transformersembeddings
|
|
:members:
|
|
:undoc-members:
|
|
:show-inheritance:
|
|
:exclude-members: model, tokenizer, model_id, model_kwargs, encode_kwargs, Config
|
|
|
|
Native Model
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
For ``llama``/``bloom``/``gptneox``/``starcoder`` model families, you could also use the following wrappers.
|
|
|
|
.. tabs::
|
|
|
|
.. tab:: Llama
|
|
|
|
.. autoclass:: ipex_llm.langchain.embeddings.LlamaEmbeddings
|
|
:members:
|
|
:undoc-members:
|
|
:show-inheritance:
|
|
:exclude-members: ggml_model, ggml_module, client, model_path, kwargs
|
|
|
|
.. automethod:: validate_environment
|
|
.. automethod:: embed_documents
|
|
.. automethod:: embed_query
|
|
|
|
.. tab:: Bloom
|
|
|
|
.. autoclass:: ipex_llm.langchain.embeddings.BloomEmbeddings
|
|
:members:
|
|
:undoc-members:
|
|
:show-inheritance:
|
|
:exclude-members: ggml_model, ggml_module, client, model_path, kwargs
|
|
|
|
.. automethod:: validate_environment
|
|
.. automethod:: embed_documents
|
|
.. automethod:: embed_query
|
|
|
|
.. tab:: Gptneox
|
|
|
|
.. autoclass:: ipex_llm.langchain.embeddings.GptneoxEmbeddings
|
|
:members:
|
|
:undoc-members:
|
|
:show-inheritance:
|
|
:exclude-members: ggml_model, ggml_module, client, model_path, kwargs
|
|
|
|
.. automethod:: validate_environment
|
|
.. automethod:: embed_documents
|
|
.. automethod:: embed_query
|
|
|
|
.. tab:: Starcoder
|
|
|
|
.. autoclass:: ipex_llm.langchain.embeddings.StarcoderEmbeddings
|
|
:members:
|
|
:undoc-members:
|
|
:show-inheritance:
|
|
:exclude-members: ggml_model, ggml_module, client, model_path, kwargs
|
|
|
|
.. automethod:: validate_environment
|
|
.. automethod:: embed_documents
|
|
.. automethod:: embed_query
|