Archives/langchain
2
0
Fork 1
mirror of https://github.com/hwchase17/langchain synced 2024-11-18 09:25:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: contribute / integrations code examples update (#19319)

Browse Source 
**Description:** Update to make the code examples consistent with the
actual use
**Issue:** Code examples were different from actual use in the LangChain
code
**Dependencies:** Changes on top of
https://github.com/langchain-ai/langchain/pull/19294

Note: If these changes are acceptable, please merge them after
https://github.com/langchain-ai/langchain/pull/19294.
This commit is contained in:
aditya thomas 2024-03-20 18:57:53 +05:30 committed by GitHub
parent 8609afbd10
commit e46419c851
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 34 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
docs/docs/contributing/integrations.mdx
View File

@ -14,19 +14,20 @@ For the most part, new integrations should be added to the Community package. Pa
In the following sections, we'll walk through how to contribute to each of these packages from a fake company, `Parrot Link AI`. In the following sections, we'll walk through how to contribute to each of these packages from a fake company, `Parrot Link AI`.
## Community Package ## Community package
The `langchain-community` package is in `libs/community` and contains most integrations. The `langchain-community` package is in `libs/community` and contains most integrations.
It is installed by users with `pip install langchain-community`, and exported members can be imported with code like It can be installed with `pip install langchain-community`, and exported members can be imported with code like
```python ```python
from langchain_community.chat_models import ParrotLinkLLM from langchain_community.chat_models import ChatParrotLink
from langchain_community.llms import ChatParrotLink from langchain_community.llms import ParrotLinkLLM
from langchain_community.vectorstores import ParrotLinkVectorStore from langchain_community.vectorstores import ParrotLinkVectorStore
``` ```
The community package relies on manually-installed dependent packages, so you will see errors if you try to import a package that is not installed. In our fake example, if you tried to import `ParrotLinkLLM` without installing `parrot-link-sdk`, you will see an `ImportError` telling you to install it when trying to use it. The `community` package relies on manually-installed dependent packages, so you will see errors
if you try to import a package that is not installed. In our fake example, if you tried to import `ParrotLinkLLM` without installing `parrot-link-sdk`, you will see an `ImportError` telling you to install it when trying to use it.
Let's say we wanted to implement a chat model for Parrot Link AI. We would create a new file in `libs/community/langchain_community/chat_models/parrot_link.py` with the following code: Let's say we wanted to implement a chat model for Parrot Link AI. We would create a new file in `libs/community/langchain_community/chat_models/parrot_link.py` with the following code:
@ -39,7 +40,7 @@ class ChatParrotLink(BaseChatModel):
Example: Example:
.. code-block:: python .. code-block:: python
from langchain_parrot_link import ChatParrotLink from langchain_community.chat_models import ChatParrotLink
model = ChatParrotLink() model = ChatParrotLink()
""" """
@ -56,9 +57,16 @@ And add documentation to:
- `docs/docs/integrations/chat/parrot_link.ipynb` - `docs/docs/integrations/chat/parrot_link.ipynb`
## Partner Packages ## Partner package in LangChain repo
Partner packages are in `libs/partners/*` and are installed by users with `pip install langchain-{partner}`, and exported members can be imported with code like Partner packages can be hosted in the `LangChain` monorepo or in an external repo.
Partner package in the `LangChain` repo is placed in `libs/partners/{partner}`
and the package source code is in `libs/partners/{partner}/langchain_{partner}`.
A package is
installed by users with `pip install langchain-{partner}`, and the package members
can be imported with code like:
```python ```python
from langchain_{partner} import X from langchain_{partner} import X
@ -123,19 +131,20 @@ By default, this will include stubs for a Chat Model, an LLM, and/or a Vector St
### Write Unit and Integration Tests ### Write Unit and Integration Tests
Some basic tests are generated in the tests/ directory. You should add more tests to cover your package's functionality. Some basic tests are presented in the `tests/` directory. You should add more tests to cover your package's functionality.
For information on running and implementing tests, see the [Testing guide](./testing). For information on running and implementing tests, see the [Testing guide](./testing).
### Write documentation ### Write documentation
Documentation is generated from Jupyter notebooks in the `docs/` directory. You should move the generated notebooks to the relevant `docs/docs/integrations` directory in the monorepo root. Documentation is generated from Jupyter notebooks in the `docs/` directory. You should place the notebooks with examples
to the relevant `docs/docs/integrations` directory in the monorepo root.
### (If Necessary) Deprecate community integration ### (If Necessary) Deprecate community integration
Note: this is only necessary if you're migrating an existing community integration into Note: this is only necessary if you're migrating an existing community integration into
a partner package. If the component you're integrating is net-new to LangChain (i.e. a partner package. If the component you're integrating is net-new to LangChain (i.e.
not already in the community package), you can skip this step. not already in the `community` package), you can skip this step.
Let's pretend we migrated our `ChatParrotLink` chat model from the community package to Let's pretend we migrated our `ChatParrotLink` chat model from the community package to
the partner package. We would need to deprecate the old model in the community package. the partner package. We would need to deprecate the old model in the community package.
@ -146,7 +155,7 @@ We would do that by adding a `@deprecated` decorator to the old model as follows
Before our change, our chat model might look like this: Before our change, our chat model might look like this:
```python ```python
class ParrotLink(BaseChatModel): class ChatParrotLink(BaseChatModel):
... ...
``` ```
@ -160,7 +169,7 @@ from langchain_core._api.deprecation import deprecated
removal="0.2.0", removal="0.2.0",
alternative_import="langchain_parrot_link.ChatParrotLink" alternative_import="langchain_parrot_link.ChatParrotLink"
) )
class ParrotLink(BaseChatModel): class ChatParrotLink(BaseChatModel):
... ...
``` ```
@ -178,3 +187,15 @@ Maintainer steps (Contributors should **not** do these):
- [ ] set up pypi and test pypi projects - [ ] set up pypi and test pypi projects
- [ ] add credential secrets to Github Actions - [ ] add credential secrets to Github Actions
- [ ] add package to conda-forge - [ ] add package to conda-forge
## Partner package in external repo
If you are creating a partner package in an external repo, you should follow the same steps as above,
but you will need to set up your own CI/CD and package management.
Name your package as `langchain-{partner}-{integration}`.
Still, you have to create the `libs/partners/{partner}-{integration}` folder in the `LangChain` monorepo
and add a `README.md` file with a link to the external repo.
See this [example](https://github.com/langchain-ai/langchain/tree/master/libs/partners/google-genai).
This allows keeping track of all the partner packages in the `LangChain` documentation.