Repository navigation
fix(embedding): route transformers cacheDir to user home cache #1215
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
Open
davdittrich
wants to merge
6
commits into
rohitg00:main
Choose a base branch
from
davdittrich:fix/transformers-cache-dir
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
d1f8e29
fix(embedding): route transformers cacheDir to user home cache
davdittrich 381815b
fix(embedding): preserve transitive import errors
davdittrich 4ea1d95
test(embedding): restore transformer mock environment
davdittrich 5f9a0b5
test(embedding): cover transformer loader review cases
davdittrich 5757bd8
test(embedding): isolate transformer import fixtures
davdittrich 0fd450f
test(embedding): clear transformer error fixture
davdittrich 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 hidden or 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 |
|---|---|---|
| @@ -1,4 +1,8 @@ | ||
| throw Object.assign( | ||
| new Error("Cannot find package '@huggingface/transformers'"), | ||
| { code: "ERR_MODULE_NOT_FOUND" }, | ||
| import { getTransformersImportError } from "../../test/fixtures/transformers-import-error.js"; | ||
|
|
||
| throw ( | ||
| getTransformersImportError() ?? | ||
| Object.assign(new Error("Cannot find package '@huggingface/transformers'"), { | ||
| code: "ERR_MODULE_NOT_FOUND", | ||
| }) | ||
| ); |
This file contains hidden or 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,40 @@ | ||
| import { homedir } from "node:os"; | ||
| import { join } from "node:path"; | ||
| import type * as TransformersType from "@huggingface/transformers"; | ||
|
|
||
| function isDirectTransformersModuleNotFound(err: unknown): err is Error { | ||
| return ( | ||
| err instanceof Error && | ||
| (err as NodeJS.ErrnoException).code === "ERR_MODULE_NOT_FOUND" && | ||
| /^(?:Cannot find package|Cannot find module) (['"])@huggingface\/transformers\1(?:$|\n| imported from )/.test( | ||
| err.message, | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| export async function loadTransformers( | ||
| purpose = "local embeddings", | ||
| ): Promise<typeof TransformersType> { | ||
| let transformers: any; | ||
| try { | ||
| transformers = await import("@huggingface/transformers"); | ||
| } catch (err) { | ||
| if (isDirectTransformersModuleNotFound(err)) { | ||
| throw new Error( | ||
| `Install @huggingface/transformers for ${purpose}: npm install @huggingface/transformers`, | ||
| { cause: err }, | ||
| ); | ||
| } | ||
| throw err; | ||
| } | ||
| try { | ||
| if (transformers && "env" in transformers && transformers.env) { | ||
| transformers.env.cacheDir = | ||
| process.env.TRANSFORMERS_CACHE || | ||
| process.env.HF_HOME || | ||
| join(homedir(), ".cache", "huggingface", "transformers"); | ||
| } | ||
| } catch { | ||
| } | ||
| return transformers; | ||
| } | ||
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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,13 @@ | ||
| let transformersImportError: Error | undefined; | ||
|
|
||
| export function setTransformersImportError(error: Error): void { | ||
| transformersImportError = error; | ||
|
coderabbitai[bot] marked this conversation as resolved.
Resolved
|
||
| } | ||
|
|
||
| export function getTransformersImportError(): Error | undefined { | ||
| return transformersImportError; | ||
| } | ||
|
|
||
| export function clearTransformersImportError(): void { | ||
| transformersImportError = undefined; | ||
| } | ||
This file contains hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.