gguf: Add ability to load local file

[ngxson]

Being able to load a local gguf file can be useful when we want to debug a gguf file.

Without this PR, this ability could be done by using file-fetch. However, that won't work with big models, since the whole file is loaded into RAM.

This PR add a new RangeViewLocalFile internal class that extends RangeView. It redirects calls to fetchChunk() to fs.createReadStream with the appropriate byte range. This allows the library to read specific chunk from a local file.

For security reason, this ability is locked under localFile: boolean param. By default, it is disabled (i.e. when this library is run on hub backend, this param is disabled if unspecified)

• Add test case to gguf.spec.ts
• Being able to build with target=browser (only build, but will throw error on browser if being used)

[coyotte508]

Note that we already have FileBlob, that you could reuse: https://github.com/huggingface/huggingface.js/blob/4fdb7cb8fdcbcde3210150e684f3e31d17cd5bab/packages/hub/src/utils/FileBlob.ts

const blob  = await Fileblob.create("./local-file");

const chunk1 = await blob.slice(start, end).then(slice => slice.arrayBuffer());
const chunk2 = ...

There are also WebBlob and even a more generic createBlob that takes any URL - that are used by @huggingface/hub internally.

It could be copied over or shared. Or a small improvement: no need for streams to get a chunk you can do it like this:

const file = await open(this.path, "r");

try {
	const chunk = await file.read(buffer, 0, end-start, start);
} finally {
	await file.close();
}

And soon with typescript 5.5 beta:

await using file = await open(this.path, "r");

const chunk = await file.read(buffer, 0, end-start, start);

---

anyway, just passing notes, will leave it up to you folks :)

[julien-c]

i'm not opposed to this (an alternative would be to document how to simply start a local webserver from where your files are)

[ngxson]

Thanks @coyotte508 for the suggestion. I ended up copying FileBlob into the gguf library, because:

• Moving it to shared ==> I'm not sure how it will effect FileBlob.spec.ts
• Via adding "@huggingface/hub": "workspace:^" to gguf/package.json ==> It doesn't compile, because FileBlob.ts is not exported

Otherwise, for now, it works fine on both node & browser. Feel free to tell me if you have other ideas.

[coyotte508]

regarding conflicts: I think you can remove type-fest from the dev dependencies

[mishig25]

@ngxson merged it 🚀

Would you mind adding a section on how to load locally in the readme https://github.com/huggingface/huggingface.js/blob/main/packages/gguf/README.md#usage ?

Thanks a lot !

[ngxson]

@mishig25 Sure, thanks for reminding, I totally forgot that.