From 8781df43b81368fd732354d8eb918c250d127116 Mon Sep 17 00:00:00 2001 From: Eugene Yurtsev Date: Wed, 8 May 2024 17:43:03 -0400 Subject: [PATCH] x --- docs/docs/upgrading/release_policy.mdx | 10 ++++++---- docs/docs/upgrading/v0.1/changes.mdx | 2 +- .../v0.1/index.mdx} | 10 ++++++---- docs/docs/upgrading/v0.2/changes.mdx | 2 +- docs/docs/upgrading/v0.2/index.mdx | 2 +- docs/docs/upgrading/v0.2/migration.mdx | 8 ++------ 6 files changed, 17 insertions(+), 17 deletions(-) rename docs/docs/{langchain_over_time.mdx => upgrading/v0.1/index.mdx} (94%) diff --git a/docs/docs/upgrading/release_policy.mdx b/docs/docs/upgrading/release_policy.mdx index d5ca5d83ff0..3bc104d1b48 100644 --- a/docs/docs/upgrading/release_policy.mdx +++ b/docs/docs/upgrading/release_policy.mdx @@ -3,7 +3,7 @@ sidebar_position: 0 sidebar_label: Release Policy --- -# LangChain Releases +# Release Policy The LangChain ecosystem is composed of different component packages (e.g., `langchain-core`, `langchain`, `langchain-community`, `langgraph`, `langserve`, partner packages etc.) @@ -28,7 +28,7 @@ When upgrading between minor versions, users should review the list of breaking From time to time, we will version packages as **release candidates**. These are versions that are intended to be released as stable versions, but we want to get feedback from the community before doing so. Release candidates will be versioned as 0.**Y**.**Z**rc**N**. For example, 0.2.0rc1. If no issues are found, the release candidate will be released as a stable version with the same version number. If issues are found, we will release a new release candidate with an incremented `N` value (e.g., 0.2.0rc2). -### Other packages in the langchain ecosystem +### Other packages Other packages in the ecosystem (including user packages) can follow a different versioning scheme, but are generally expected to pin to specific minor versions of `langchain` and `langchain-core`. @@ -42,6 +42,8 @@ Patch versions are released frequently as they contain bug fixes and new feature The development of LLM applications is a rapidly evolving field, and we are constantly learning from our users and the community. As such, we expect that the APIs in `langchain` and `langchain-core` will continue to evolve to better serve the needs of our users. +### `langchain` and `langchain-core` + Even though both `langchain` and `langchain-core` are currently in a pre-1.0 state, we are committed to maintaining API stability in these packages. - Breaking changes to the public API will result in a minor version bump (the second digit) @@ -49,14 +51,14 @@ Even though both `langchain` and `langchain-core` are currently in a pre-1.0 sta We will generally try to avoid making unnecessary changes, and will provide a deprecation policy for features that are being removed. -### Stability of Other Packages +### Other Packages The stability of other packages in the LangChain ecosystem may vary: - `langchain-community` is a community maintained package that contains 3rd party integrations. While we do our best to review and test changes in `langchain-community`, `langchain-community` is expected to experience more breaking changes than `langchain` and `langchain-core` as it contains many community contributions. - Partner packages may follow different stability and versioning policies, and users should refer to the documentation of those packages for more information; however, in general these packages are expected to be stable. -### What is a "API Stability"? +## What is a "API Stability"? API stability means: diff --git a/docs/docs/upgrading/v0.1/changes.mdx b/docs/docs/upgrading/v0.1/changes.mdx index f73e8015d9b..e08efcf40b8 100644 --- a/docs/docs/upgrading/v0.1/changes.mdx +++ b/docs/docs/upgrading/v0.1/changes.mdx @@ -1,6 +1,6 @@ --- sidebar_position: 0 -sidebar_label: Breaking Changes +sidebar_label: Changes --- # Deprecations and Breaking Changes diff --git a/docs/docs/langchain_over_time.mdx b/docs/docs/upgrading/v0.1/index.mdx similarity index 94% rename from docs/docs/langchain_over_time.mdx rename to docs/docs/upgrading/v0.1/index.mdx index 433a972f8f6..75cc196e433 100644 --- a/docs/docs/langchain_over_time.mdx +++ b/docs/docs/upgrading/v0.1/index.mdx @@ -1,11 +1,13 @@ +--- +sidebar_position: 0 +sidebar_label: Upgrading to 0.1 +--- + # LangChain Over Time Due to the rapidly evolving field, LangChain has also evolved rapidly. This document serves to outline at a high level what has changed and why. -## 0.2 - - ## 0.1 The 0.1 release marked a few key changes for LangChain. @@ -42,4 +44,4 @@ This meant that ALL integrations lived inside `langchain`. Most high level chains were largely their own classes. There was a base `Chain` class from which all chains inherited. This meant that in order to chain the logic inside a chain you basically had to modify the source code. -There were a few chains that were meant to be more generic (`SequentialChain`, `RouterChain`) \ No newline at end of file +There were a few chains that were meant to be more generic (`SequentialChain`, `RouterChain`) diff --git a/docs/docs/upgrading/v0.2/changes.mdx b/docs/docs/upgrading/v0.2/changes.mdx index af688ad3c52..b7d1508ff8b 100644 --- a/docs/docs/upgrading/v0.2/changes.mdx +++ b/docs/docs/upgrading/v0.2/changes.mdx @@ -1,6 +1,6 @@ --- sidebar_position: 1 -sidebar_label: Breaking Changes +sidebar_label: Changes --- # Deprecations and Breaking Changes diff --git a/docs/docs/upgrading/v0.2/index.mdx b/docs/docs/upgrading/v0.2/index.mdx index 8f9a51142fb..fb17bf4808b 100644 --- a/docs/docs/upgrading/v0.2/index.mdx +++ b/docs/docs/upgrading/v0.2/index.mdx @@ -1,6 +1,6 @@ --- sidebar_position: 0 -sidebar_label: Overview +sidebar_label: Upgrading to 0.2 --- # LangChain Over Time diff --git a/docs/docs/upgrading/v0.2/migration.mdx b/docs/docs/upgrading/v0.2/migration.mdx index c5396c6f7b3..c2bbd7ae050 100644 --- a/docs/docs/upgrading/v0.2/migration.mdx +++ b/docs/docs/upgrading/v0.2/migration.mdx @@ -9,13 +9,9 @@ This documentation will help you upgrade your code to LangChain 0.2.x. :::warning -Do not migrate your code to LangChain 0.2.x until you have read this guide until -the official release of LangChain 0.2.0 on the week of May 20. - -We will release RC versions of LangChain 0.2.x before the official release. -You can test your code with these versions to make sure it works properly, but -we recommend waiting until the official release to migrate your code. +Do not migrate your code to LangChain 0.2.x until the official release of LangChain 0.2.0 on the week of May 20. +RC versions of LangChain 0.2.x will be released before the official release. You can test your code with these versions to make sure it works properly, but we recommend waiting until the official release to migrate your code. ::: ## Migration