Skip to content
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 2 commits into from
Feb 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions docs/core_docs/docs/guides/migrating.mdx
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>
1 change: 1 addition & 0 deletions examples/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
"@langchain/openai": "workspace:*",
"@langchain/pinecone": "workspace:*",
"@langchain/redis": "workspace:*",
"@langchain/scripts": "workspace:*",
"@langchain/weaviate": "workspace:*",
"@langchain/yandex": "workspace:*",
"@opensearch-project/opensearch": "^2.2.0",
Expand Down
8 changes: 8 additions & 0 deletions examples/src/guides/migrating.ts
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",
});
3 changes: 3 additions & 0 deletions libs/langchain-scripts/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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
12 changes: 11 additions & 1 deletion libs/langchain-scripts/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@
"license": "MIT",
Copy link

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!

"dependencies": {
"commander": "^11.1.0",
"glob": "^10.3.10",
"rollup": "^4.5.2",
"ts-morph": "^21.0.1",
"typescript": "<5.2.0"
},
"devDependencies": {
Expand Down Expand Up @@ -76,6 +78,11 @@
"import": "./build.js",
"require": "./build.cjs"
},
"./migrations": {
"types": "./migrations.d.ts",
"import": "./migrations.js",
"require": "./migrations.cjs"
},
"./package.json": "./package.json"
},
"files": [
Expand All @@ -85,6 +92,9 @@
"index.d.ts",
"build.cjs",
"build.js",
"build.d.ts"
"build.d.ts",
"migrations.cjs",
"migrations.js",
"migrations.d.ts"
]
}
1 change: 1 addition & 0 deletions libs/langchain-scripts/scripts/create-entrypoints.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ const DEFAULT_GITIGNORE_PATHS = ["node_modules", "dist", ".yarn"];
const entrypoints = {
index: "index",
build: "build",
migrations: "migrations/index",
};

// Entrypoints in this list require an optional dependency to be installed.
Expand Down
Loading
Loading