mirror of
https://github.com/hwchase17/langchain.git
synced 2026-04-04 19:35:08 +00:00
Use docusaurus versioning with a callout, merged master as well @hwchase17 @baskaryan --------- Signed-off-by: Weichen Xu <weichen.xu@databricks.com> Signed-off-by: Rahul Tripathi <rauhl.psit.ec@gmail.com> Co-authored-by: Leonid Ganeline <leo.gan.57@gmail.com> Co-authored-by: Leonid Kuligin <lkuligin@yandex.ru> Co-authored-by: Averi Kitsch <akitsch@google.com> Co-authored-by: Erick Friis <erick@langchain.dev> Co-authored-by: Nuno Campos <nuno@langchain.dev> Co-authored-by: Nuno Campos <nuno@boringbits.io> Co-authored-by: Bagatur <22008038+baskaryan@users.noreply.github.com> Co-authored-by: Eugene Yurtsev <eyurtsev@gmail.com> Co-authored-by: Martín Gotelli Ferenaz <martingotelliferenaz@gmail.com> Co-authored-by: Fayfox <admin@fayfox.com> Co-authored-by: Eugene Yurtsev <eugene@langchain.dev> Co-authored-by: Dawson Bauer <105886620+djbauer2@users.noreply.github.com> Co-authored-by: Ravindu Somawansa <ravindu.somawansa@gmail.com> Co-authored-by: Dhruv Chawla <43818888+Dominastorm@users.noreply.github.com> Co-authored-by: ccurme <chester.curme@gmail.com> Co-authored-by: Bagatur <baskaryan@gmail.com> Co-authored-by: WeichenXu <weichen.xu@databricks.com> Co-authored-by: Benito Geordie <89472452+benitoThree@users.noreply.github.com> Co-authored-by: kartikTAI <129414343+kartikTAI@users.noreply.github.com> Co-authored-by: Kartik Sarangmath <kartik@thirdai.com> Co-authored-by: Sevin F. Varoglu <sfvaroglu@octoml.ai> Co-authored-by: MacanPN <martin.triska@gmail.com> Co-authored-by: Prashanth Rao <35005448+prrao87@users.noreply.github.com> Co-authored-by: Hyeongchan Kim <kozistr@gmail.com> Co-authored-by: sdan <git@sdan.io> Co-authored-by: Guangdong Liu <liugddx@gmail.com> Co-authored-by: Rahul Triptahi <rahul.psit.ec@gmail.com> Co-authored-by: Rahul Tripathi <rauhl.psit.ec@gmail.com> Co-authored-by: pjb157 <84070455+pjb157@users.noreply.github.com> Co-authored-by: Eun Hye Kim <ehkim1440@gmail.com> Co-authored-by: kaijietti <43436010+kaijietti@users.noreply.github.com> Co-authored-by: Pengcheng Liu <pcliu.fd@gmail.com> Co-authored-by: Tomer Cagan <tomer@tomercagan.com> Co-authored-by: Christophe Bornet <cbornet@hotmail.com>
56 lines
1.8 KiB
Plaintext
56 lines
1.8 KiB
Plaintext
# GPT4All
|
|
|
|
This page covers how to use the `GPT4All` wrapper within LangChain. The tutorial is divided into two parts: installation and setup, followed by usage with an example.
|
|
|
|
## Installation and Setup
|
|
|
|
- Install the Python package with `pip install gpt4all`
|
|
- Download a [GPT4All model](https://gpt4all.io/index.html) and place it in your desired directory
|
|
|
|
In this example, We are using `mistral-7b-openorca.Q4_0.gguf`(Best overall fast chat model):
|
|
|
|
```bash
|
|
mkdir models
|
|
wget https://gpt4all.io/models/gguf/mistral-7b-openorca.Q4_0.gguf -O models/mistral-7b-openorca.Q4_0.gguf
|
|
```
|
|
|
|
## Usage
|
|
|
|
### GPT4All
|
|
|
|
To use the GPT4All wrapper, you need to provide the path to the pre-trained model file and the model's configuration.
|
|
|
|
```python
|
|
from langchain_community.llms import GPT4All
|
|
|
|
# Instantiate the model. Callbacks support token-wise streaming
|
|
model = GPT4All(model="./models/mistral-7b-openorca.Q4_0.gguf", n_threads=8)
|
|
|
|
# Generate text
|
|
response = model("Once upon a time, ")
|
|
```
|
|
|
|
You can also customize the generation parameters, such as n_predict, temp, top_p, top_k, and others.
|
|
|
|
To stream the model's predictions, add in a CallbackManager.
|
|
|
|
```python
|
|
from langchain_community.llms import GPT4All
|
|
from langchain.callbacks.streaming_stdout import StreamingStdOutCallbackHandler
|
|
|
|
# There are many CallbackHandlers supported, such as
|
|
# from langchain.callbacks.streamlit import StreamlitCallbackHandler
|
|
|
|
callbacks = [StreamingStdOutCallbackHandler()]
|
|
model = GPT4All(model="./models/mistral-7b-openorca.Q4_0.gguf", n_threads=8)
|
|
|
|
# Generate text. Tokens are streamed through the callback manager.
|
|
model("Once upon a time, ", callbacks=callbacks)
|
|
```
|
|
|
|
## Model File
|
|
|
|
You can find links to model file downloads in the [https://gpt4all.io/](https://gpt4all.io/index.html).
|
|
|
|
For a more detailed walkthrough of this, see [this notebook](/docs/integrations/llms/gpt4all)
|