gguf: better type usage #655
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
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
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,55 @@ | ||
| import { describe, it } from "vitest"; | ||
| import type { gguf } from "./gguf"; | ||
| import type { GGUFMetadata, GGUFParseOutput, GGUFType } from "./types"; | ||
|
|
||
| describe("gguf-types", () => { | ||
| it("gguf() type can be casted (at compile time)", async () => { | ||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
| const result: Awaited<ReturnType<typeof gguf>> = null as any; | ||
| const strictType = result as GGUFParseOutput<GGUFType.strict>; | ||
| // @ts-expect-error because the key "abc" does not exist | ||
| strictType.metadata.abc = 123; | ||
| const nonStrictType = result as GGUFParseOutput<GGUFType.nonStrict>; | ||
| nonStrictType.metadata.abc = 123; // PASS, because it can be anything | ||
| // @ts-expect-error because ArrayBuffer is not a MetadataValue | ||
| nonStrictType.metadata.fff = ArrayBuffer; | ||
| }); | ||
|
|
||
| it("GGUFType.nonStrict should be correct (at compile time)", async () => { | ||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
| const model: GGUFMetadata<GGUFType.nonStrict> = null as any; | ||
| model.kv_count = 123n; | ||
| model.abc = 456; // PASS, because it can be anything | ||
| }); | ||
|
|
||
| it("GGUFType.strict should be correct (at compile time)", async () => { | ||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
| const model: GGUFMetadata<GGUFType.strict> = null as any; | ||
|
|
||
| if (model["general.architecture"] === "whisper") { | ||
| model["encoder.whisper.block_count"] = 0; | ||
| // @ts-expect-error because it must be a number | ||
| model["encoder.whisper.block_count"] = "abc"; | ||
| } | ||
|
|
||
| if (model["tokenizer.ggml.model"] === undefined) { | ||
| // @ts-expect-error because it's undefined | ||
| model["tokenizer.ggml.eos_token_id"] = 1; | ||
| } | ||
| if (model["tokenizer.ggml.model"] === "gpt2") { | ||
| // @ts-expect-error because it must be a number | ||
| model["tokenizer.ggml.eos_token_id"] = undefined; | ||
| model["tokenizer.ggml.eos_token_id"] = 1; | ||
| } | ||
|
|
||
| if (model["general.architecture"] === "mamba") { | ||
| model["mamba.ssm.conv_kernel"] = 0; | ||
| // @ts-expect-error because it must be a number | ||
| model["mamba.ssm.conv_kernel"] = "abc"; | ||
| } | ||
| if (model["general.architecture"] === "llama") { | ||
| // @ts-expect-error llama does not have ssm.* keys | ||
| model["mamba.ssm.conv_kernel"] = 0; | ||
| } | ||
| }); | ||
| }); |
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.
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.
Let's use
// @ts-expect-errorinstead of// @ts-ignorein general(no need for eslint-disable this way)
Here I think you can change
const metadata: GGUFMetadatatoconst metadata: GGUFMetadata<GGUFType.NON_STRICT>to remove the error (not sure if it's the best fix)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.
Fixed in 31bac8b