Skip to content

Commit

Permalink
docs: add changelog (#15606)
Browse files Browse the repository at this point in the history
<!-- Thank you for contributing to LangChain!

Please title your PR "<package>: <description>", where <package> is
whichever of langchain, community, core, experimental, etc. is being
modified.

Replace this entire comment with:
  - **Description:** a description of the change, 
  - **Issue:** the issue # it fixes if applicable,
  - **Dependencies:** any dependencies required for this change,
- **Twitter handle:** we announce bigger features on Twitter. If your PR
gets announced, and you'd like a mention, we'll gladly shout you out!

Please make sure your PR is passing linting and testing before
submitting. Run `make format`, `make lint` and `make test` from the root
of the package you've modified to check this locally.

See contribution guidelines for more information on how to write/run
tests, lint, etc: https://python.langchain.com/docs/contributing/

If you're adding a new integration, please include:
1. a test for the integration, preferably unit tests that do not rely on
network access,
2. an example notebook showing its use. It lives in
`docs/docs/integrations` directory.

If no one reviews your PR within a few days, please @-mention one of
@baskaryan, @eyurtsev, @hwchase17.
 -->

---------

Co-authored-by: Harrison Chase <hw.chase.17@gmail.com>
  • Loading branch information
baskaryan and hwchase17 committed Jan 7, 2024
1 parent d1bfb70 commit 4759d10
Show file tree
Hide file tree
Showing 7 changed files with 106 additions and 79 deletions.
27 changes: 27 additions & 0 deletions docs/docs/changelog/core.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# langchain-core

## 0.1.7 (Jan 5, 2024)

#### Deleted

No deletions.

#### Deprecated

- `BaseChatModel` methods `__call__`, `call_as_llm`, `predict`, `predict_messages`. Will be removed in 0.2.0. Use `BaseChatModel.invoke` instead.
- `BaseChatModel` methods `apredict`, `apredict_messages`. Will be removed in 0.2.0. Use `BaseChatModel.ainvoke` instead.
- `BaseLLM` methods `__call__, `predict`, `predict_messages`. Will be removed in 0.2.0. Use `BaseLLM.invoke` instead.
- `BaseLLM` methods `apredict`, `apredict_messages`. Will be removed in 0.2.0. Use `BaseLLM.ainvoke` instead.

#### Fixed

- Restrict recursive URL scraping: [#15559](https://github.com/langchain-ai/langchain/pull/15559)

#### Added

No additions.

#### Beta

- Marked `langchain_core.load.load` and `langchain_core.load.loads` as beta.
- Marked `langchain_core.beta.runnables.context.ContextGet` and `langchain_core.beta.runnables.context.ContextSet` as beta.
36 changes: 36 additions & 0 deletions docs/docs/changelog/langchain.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# langchain

## 0.1.0 (Jan 5, 2024)

#### Deleted

No deletions.

#### Deprecated

Deprecated classes and methods will be removed in 0.2.0

| Deprecated | Alternative | Reason |
|---------------------------------|-----------------------------------|------------------------------------------------|
| ChatVectorDBChain | ConversationalRetrievalChain | More general to all retrievers |
| create_ernie_fn_chain | create_ernie_fn_runnable | Use LCEL under the hood |
| created_structured_output_chain | create_structured_output_runnable | Use LCEL under the hood |
| NatBotChain | | Not used |
| create_openai_fn_chain | create_openai_fn_runnable | Use LCEL under the hood |
| create_structured_output_chain | create_structured_output_runnable | Use LCEL under the hood |
| load_query_constructor_chain | load_query_constructor_runnable | Use LCEL under the hood |
| VectorDBQA | RetrievalQA | More general to all retrievers |
| Sequential Chain | LCEL | Obviated by LCEL |
| SimpleSequentialChain | LCEL | Obviated by LCEL |
| TransformChain | LCEL/RunnableLambda | Obviated by LCEL |
| create_tagging_chain | create_structured_output_runnable | Use LCEL under the hood |
| ChatAgent | create_react_agent | Use LCEL builder over a class |
| ConversationalAgent | create_react_agent | Use LCEL builder over a class |
| ConversationalChatAgent | create_json_chat_agent | Use LCEL builder over a class |
| initialize_agent | Individual create agent methods | Individual create agent methods are more clear |
| ZeroShotAgent | create_react_agent | Use LCEL builder over a class |
| OpenAIFunctionsAgent | create_openai_functions_agent | Use LCEL builder over a class |
| OpenAIMultiFunctionsAgent | create_openai_tools_agent | Use LCEL builder over a class |
| SelfAskWithSearchAgent | create_self_ask_with_search | Use LCEL builder over a class |
| StructuredChatAgent | create_structured_chat_agent | Use LCEL builder over a class |
| XMLAgent | create_xml_agent | Use LCEL builder over a class |
53 changes: 0 additions & 53 deletions docs/docs/community.md

This file was deleted.

29 changes: 17 additions & 12 deletions docs/docs/contributing/packages.mdx → docs/docs/packages.mdx
Original file line number Diff line number Diff line change
@@ -1,38 +1,43 @@
---
sidebar_label: Package Versioning
sidebar_position: 4
---

# 📕 Package Versioning

As of now, LangChain has an ad hoc release process: releases are cut with high frequency by
a maintainer and published to [PyPI](https://pypi.org/).
a maintainer and published to [PyPI](https://pypi.org/).
The different packages are versioned slightly differently.

## `langchain-core`

`langchain-core` is currently on version `0.1.x`.

As `langchain-core` contains the base abstractions and runtime for the whole LangChain ecosystem, we will communicate any breaking changes with advance notice and version bumps. The exception for this is anything in `langchain_core.beta`. The reason for `langchain_core.beta` is that given the rate of change of the field, being able to move quickly is still a priority, and this module is our attempt to do so.
As `langchain-core` contains the base abstractions and runtime for the whole LangChain ecosystem, we will communicate any breaking changes with advance notice and version bumps. The exception for this is anything marked with the `beta` decorator (you can see this in the API reference and will see warnings when using such functionality). The reason for beta features is that given the rate of change of the field, being able to move quickly is still a priority.

Minor version increases will occur for:

- Breaking changes for any public interfaces NOT in `langchain_core.beta`
- Breaking changes for any public interfaces marked as `beta`.

Patch version increases will occur for:

- Bug fixes
- New features
- Any changes to private interfaces
- Any changes to `langchain_core.beta`
- Any changes to `beta` features

## `langchain`

`langchain` is currently on version `0.0.x`
`langchain` is currently on version `0.1.x`

Minor version increases will occur for:

All changes will be accompanied by a patch version increase. Any changes to public interfaces are nearly always done in a backwards compatible way and will be communicated ahead of time when they are not backwards compatible.
- Breaking changes for any public interfaces NOT marked as `beta`.

Patch version increases will occur for:

- Bug fixes
- New features
- Any changes to private interfaces
- Any changes to `beta` features

We are targeting January 2024 for a release of `langchain` v0.1, at which point `langchain` will adopt the same versioning policy as `langchain-core`.
We are targeting February 2024 for a release of `langchain` v0.2, which will have some breaking changes to legacy Chains and Agents.
Additionally, we will remove `langchain-community` as a dependency and stop re-exporting integrations that have been moved to `langchain-community`.

## `langchain-community`

Expand Down
24 changes: 10 additions & 14 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -178,39 +178,35 @@ const config = {
position: "left",
items: [
{
type: "docSidebar",
sidebarId: "templates",
label: "Templates",
to: "/docs/packages",
label: "Versioning",
},
{
to: "/docs/community",
label: "Community",
type: "docSidebar",
sidebarId: "changelog",
label: "Changelog",
},
{
to: "/docs/contributing",
label: "Developer's guide",
},
{
to: "/docs/additional_resources/dependents",
label: "Dependents",
type: "docSidebar",
sidebarId: "templates",
label: "Templates",
},
{
label: "Integrations Hub",
href: "https://integrations.langchain.com/",
label: "Cookbooks",
href: "https://github.com/langchain-ai/langchain/blob/master/cookbook/README.md"
},
{
to: "/docs/additional_resources/tutorials",
label: "Tutorials"
},
{
label: "Cookbooks",
href: "https://github.com/langchain-ai/langchain/blob/master/cookbook/README.md"
},
{
to: "/docs/additional_resources/youtube",
label: "YouTube videos"
},
{ label: "Gallery", href: "https://github.com/kyrolabs/awesome-langchain" }
]
},
{
Expand Down
8 changes: 8 additions & 0 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,14 @@ module.exports = {
link: { type: 'doc', id: "templates/index" }
},
],
changelog: [
{
type: "category",
label: "Changelog",
items: [{ type: "autogenerated", dirName: "changelog" }],
link: { type: 'generated-index', slug: "changelog"}
},
],
contributing: [
{type: "autogenerated", dirName: "contributing" }
],
Expand Down
8 changes: 8 additions & 0 deletions docs/vercel.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
{
"redirects": [
{
"source": "/docs/contributing/packages",
"destination": "/docs/packages"
},
{
"source": "/docs/community",
"destination": "/docs/contributing"
},
{
"source": "/docs/modules/chains/(.+)",
"destination": "/docs/modules/chains"
Expand Down

0 comments on commit 4759d10

Please sign in to comment.