github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-09-08 14:31:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs ecosystem/integrations update 3 (#5470)

Browse Source 
# docs: `ecosystem_integrations` update 3

Next cycle of updating the `ecosystem/integrations`
* Added an integration `template` file
* Added missed integration files
* Fixed several document_loaders/notebooks

## Who can review?

Is it possible to assign somebody to review PRs on docs? Thanks.
This commit is contained in:
Leonid Ganeline
2023-05-31 17:54:05 -07:00
committed by GitHub
parent bc66b3fb8d
commit 373ad49157
29 changed files with 572 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
docs/templates/integration.md vendored Normal file
View File

@@ -0,0 +1,64 @@
[comment: Please, a reference example here "docs/integrations/arxiv.md"]::
[comment: Use this template to create a new .md file in "docs/integrations/"]::
# Title_REPLACE_ME
[comment: Only one Tile/H1 is allowed!]::
>
[comment: Description: After reading this description, a reader should decide if this integration is good enough to try/follow reading OR]::
[comment: go to read the next integration doc. ]::
[comment: Description should include a link to the source for follow reading.]::
## Installation and Setup
[comment: Installation and Setup: All necessary additional package installations and set ups for Tokens, etc]::
```bash
pip install package_name_REPLACE_ME
```
[comment: OR this text:]::
There isn't any special setup for it.
[comment: The next H2/## sections with names of the integration modules, like "LLM", "Text Embedding Models", etc]::
[comment: see "Modules" in the "index.html" page]::
[comment: Each H2 section should include a link to an example(s) and a python code with import of the integration class]::
[comment: Below are several example sections. Remove all unnecessary sections. Add all necessary sections not provided here.]::
## LLM
See a [usage example](../modules/models/llms/integrations/INCLUDE_REAL_NAME.ipynb).
```python
from langchain.llms import integration_class_REPLACE_ME
```
## Text Embedding Models
See a [usage example](../modules/models/text_embedding/examples/INCLUDE_REAL_NAME.ipynb)
```python
from langchain.embeddings import integration_class_REPLACE_ME
```
## Chat Models
See a [usage example](../modules/models/chat/integrations/INCLUDE_REAL_NAME.ipynb)
```python
from langchain.chat_models import integration_class_REPLACE_ME
```
## Document Loader
See a [usage example](../modules/indexes/document_loaders/examples/INCLUDE_REAL_NAME.ipynb).
```python
from langchain.document_loaders import integration_class_REPLACE_ME
```