-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
scripts[minor],docs[minor]: Add migration script to scripts package #4326
Merged
Merged
Changes from all commits
Commits
Show all changes
2 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
--- | ||
title: Migrating to 0.1 | ||
hide_table_of_contents: true | ||
--- | ||
|
||
# Migration guide: 0.0 -> 0.1 | ||
|
||
If you're still using the pre `0.1` version of LangChain, but want to upgrade to the latest version, we've created a script that can handle almost every aspect of the migration for you. | ||
|
||
At a high level, the changes from `0.0` to `0.1` are new packages and import path updates. | ||
We've done our best to keep all core code functionality the same, so migrating can be as painless as possible. | ||
|
||
In simple terms, this script will scan your TypeScript codebase for any imports from `langchain/*`, and if it finds imports which have been moved in `0.1`, it'll automatically update the import paths for you. | ||
|
||
The new packages it checks for are: | ||
|
||
- `@langchain/core` | ||
- `@langchain/community` | ||
- `@langchain/openai` | ||
- `@langchain/cohere` | ||
- `@langchain/pinecone` | ||
|
||
Some of these integration packages (not `core` or `community`) do have breaking changes. If you'd like to opt out of updating to those modules, you may pass in the `skipCheck` arg with a list of modules you'd like to ignore. | ||
|
||
For example, `@langchain/cohere` bumps to the new Cohere SDK version. If you do not wish to upgrade, it will instead update your `cohere` imports to the `@langchain/community` package which still contains the previous version of the Cohere SDK. | ||
|
||
The example below demonstrates how to run the migration script, checking all new packages. | ||
|
||
### Setup | ||
|
||
Install the new packages. | ||
|
||
import IntegrationInstallTooltip from "@mdx_components/integration_install_tooltip.mdx"; | ||
import CodeBlock from "@theme/CodeBlock"; | ||
import MigrationExample from "@examples/guides/migrating.ts"; | ||
|
||
<IntegrationInstallTooltip></IntegrationInstallTooltip> | ||
|
||
Install the scripts package to import the migration script: | ||
|
||
```bash npm2yarn | ||
npm install @langchain/scripts | ||
``` | ||
|
||
Then, install any integration packages you'd like to use: | ||
|
||
```bash npm2yarn | ||
npm install @langchain/core @langchain/community @langchain/openai @langchain/cohere @langchain/pinecone | ||
``` | ||
|
||
Then, run the migration code as seen below. | ||
|
||
<CodeBlock language="typescript">{MigrationExample}</CodeBlock> |
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 |
---|---|---|
@@ -0,0 +1,8 @@ | ||
import { updateEntrypointsFrom0_0_xTo0_1_x } from "@langchain/scripts/migrations"; | ||
|
||
await updateEntrypointsFrom0_0_xTo0_1_x({ | ||
// Path to the local langchainjs repository | ||
localLangChainPath: "/Users/my-profile/langchainjs", | ||
// Path to the repository where the migration should be applied | ||
codePath: "/Users/my-profile/langchainjs-project", | ||
}); |
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 |
---|---|---|
|
@@ -4,6 +4,9 @@ index.d.ts | |
build.cjs | ||
build.js | ||
build.d.ts | ||
migrations.cjs | ||
migrations.js | ||
migrations.d.ts | ||
node_modules | ||
dist | ||
.yarn |
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
Oops, something went wrong.
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.
Hey there! I noticed that this PR adds new dependencies to the "dependencies" section, which affects the peer dependencies of the project. I've flagged this for your review. Keep up the great work!