-
Notifications
You must be signed in to change notification settings - Fork 16k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: integrations
references update 7
#25217
Merged
ccurme
merged 3 commits into
langchain-ai:master
from
leo-gan:docs-integrations-missed-references-fix-7
Aug 14, 2024
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,50 @@ | ||
# Llama.cpp | ||
|
||
This page covers how to use [llama.cpp](https://github.com/ggerganov/llama.cpp) within LangChain. | ||
It is broken into two parts: installation and setup, and then references to specific Llama-cpp wrappers. | ||
>[llama.cpp python](https://github.com/abetlen/llama-cpp-python) library is a simple Python bindings for `@ggerganov` | ||
>[llama.cpp](https://github.com/ggerganov/llama.cpp). | ||
> | ||
>This package provides: | ||
> | ||
> - Low-level access to C API via ctypes interface. | ||
> - High-level Python API for text completion | ||
> - `OpenAI`-like API | ||
> - `LangChain` compatibility | ||
> - `LlamaIndex` compatibility | ||
> - OpenAI compatible web server | ||
> - Local Copilot replacement | ||
> - Function Calling support | ||
> - Vision API support | ||
> - Multiple Models | ||
|
||
## Installation and Setup | ||
- Install the Python package with `pip install llama-cpp-python` | ||
|
||
- Install the Python package | ||
```bash | ||
pip install llama-cpp-python | ||
```` | ||
- Download one of the [supported models](https://github.com/ggerganov/llama.cpp#description) and convert them to the llama.cpp format per the [instructions](https://github.com/ggerganov/llama.cpp) | ||
|
||
## Wrappers | ||
|
||
### LLM | ||
## Chat models | ||
|
||
See a [usage example](/docs/integrations/chat/llamacpp). | ||
|
||
```python | ||
from langchain_community.chat_models import ChatLlamaCpp | ||
``` | ||
|
||
## LLMs | ||
|
||
See a [usage example](/docs/integrations/llms/llamacpp). | ||
|
||
There exists a LlamaCpp LLM wrapper, which you can access with | ||
```python | ||
from langchain_community.llms import LlamaCpp | ||
``` | ||
For a more detailed walkthrough of this, see [this notebook](/docs/integrations/llms/llamacpp) | ||
|
||
### Embeddings | ||
## Embedding models | ||
|
||
See a [usage example](/docs/integrations/text_embedding/llamacpp). | ||
|
||
There exists a LlamaCpp Embeddings wrapper, which you can access with | ||
```python | ||
from langchain_community.embeddings import LlamaCppEmbeddings | ||
``` | ||
For a more detailed walkthrough of this, see [this notebook](/docs/integrations/text_embedding/llamacpp) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# MariTalk | ||
|
||
>[MariTalk](https://www.maritaca.ai/en) is an LLM-based chatbot trained to meet the needs of Brazil. | ||
|
||
## Installation and Setup | ||
|
||
You have to get the MariTalk API key. | ||
|
||
You also need to install the `httpx` Python package. | ||
|
||
```bash | ||
pip install httpx | ||
``` | ||
|
||
## Chat models | ||
|
||
See a [usage example](/docs/integrations/chat/maritalk). | ||
|
||
```python | ||
from langchain_community.chat_models import ChatMaritalk | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# MLX | ||
|
||
>[MLX](https://ml-explore.github.io/mlx/build/html/index.html) is a `NumPy`-like array framework | ||
> designed for efficient and flexible machine learning on `Apple` silicon, | ||
> brought to you by `Apple machine learning research`. | ||
|
||
|
||
## Installation and Setup | ||
|
||
Install several Python packages: | ||
|
||
```bash | ||
pip install mlx-lm transformers huggingface_hub | ||
```` | ||
|
||
|
||
## Chat models | ||
|
||
|
||
See a [usage example](/docs/integrations/chat/mlx). | ||
|
||
```python | ||
from langchain_community.chat_models.mlx import ChatMLX | ||
``` | ||
|
||
## LLMs | ||
|
||
### MLX Local Pipelines | ||
|
||
See a [usage example](/docs/integrations/llms/mlx_pipelines). | ||
|
||
```python | ||
from langchain_community.llms.mlx_pipeline import MLXPipeline | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# OctoAI | ||
|
||
>[OctoAI](https://docs.octoai.cloud/docs) offers easy access to efficient compute | ||
> and enables users to integrate their choice of AI models into applications. | ||
> The `OctoAI` compute service helps you run, tune, and scale AI applications easily. | ||
|
||
|
||
## Installation and Setup | ||
|
||
- Install the `openai` Python package: | ||
```bash | ||
pip install openai | ||
```` | ||
- Register on `OctoAI` and get an API Token from [your OctoAI account page](https://octoai.cloud/settings). | ||
|
||
|
||
## Chat models | ||
|
||
See a [usage example](/docs/integrations/chat/octoai). | ||
|
||
```python | ||
from langchain_community.chat_models import ChatOctoAI | ||
``` | ||
|
||
## LLMs | ||
|
||
See a [usage example](/docs/integrations/llms/octoai). | ||
|
||
```python | ||
from langchain_community.llms.octoai_endpoint import OctoAIEndpoint | ||
``` | ||
|
||
## Embedding models | ||
|
||
```python | ||
from langchain_community.embeddings.octoai_embeddings import OctoAIEmbeddings | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Perplexity | ||
|
||
>[Perplexity](https://www.perplexity.ai/pro) is the most powerful way to search | ||
> the internet with unlimited Pro Search, upgraded AI models, unlimited file upload, | ||
> image generation, and API credits. | ||
> | ||
> You can check a [list of available models](https://docs.perplexity.ai/docs/model-cards). | ||
|
||
## Installation and Setup | ||
|
||
Install a Python package: | ||
|
||
```bash | ||
pip install openai | ||
```` | ||
|
||
Get your API key from [here](https://docs.perplexity.ai/docs/getting-started). | ||
|
||
## Chat models | ||
|
||
See a [usage example](/docs/integrations/chat/perplexity). | ||
|
||
```python | ||
from langchain_community.chat_models import ChatPerplexity | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
admittedly this is inconsistent in the docs, but the template for chat models specifies a "Chat" prefix (see issue here: #22296)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ccurme Change the template, please.
The integration example page is a document for humans. The page title should not be the names of classes, especially because the examples are not "example per class" pages. Integration examples are about the integrated System/Service/Package not about the integration implementation (hence not about classes/functions). We have API Ref that is exactly about the implementation.
The
docs/integrations/
pages for the first-time readers who chose the best integration for the use case or learn how this integration works [in the most base use case].The API Reference is for developers who work with real projects and need all internal details.