LLM for Unity  v2.3.0
Create characters in Unity with LLMs!
Loading...
Searching...
No Matches
LLMUnity.GGUFReader Class Reference

Class implementing the GGUF reader. More...

Public Member Functions

 GGUFReader (string path)
 Constructor of the GGUF reader that parses a GGUF file and retrieves the fields.
 
ReaderField GetField (string key)
 Allows to retrieve location info for a GGUF field.
 
byte[] GetGenericField (string key)
 Allows to retrieve a single-valued GGUF field.
 
string GetStringField (string key)
 Allows to retrieve a string GGUF field.
 
int GetIntField (string key)
 Allows to retrieve an integer GGUF field.
 

Public Attributes

Dictionary< string, ReaderField > fields = new Dictionary<string, ReaderField>()
 Dictionary of GGUF fields to location info.
 

Detailed Description

Class implementing the GGUF reader.

Definition at line 54 of file LLMGGUF.cs.

Constructor & Destructor Documentation

◆ GGUFReader()

LLMUnity.GGUFReader.GGUFReader ( string path)
inline

Constructor of the GGUF reader that parses a GGUF file and retrieves the fields.

Parameters
pathGGUF file path to read

Definition at line 83 of file LLMGGUF.cs.

Member Function Documentation

◆ GetField()

ReaderField LLMUnity.GGUFReader.GetField ( string key)
inline

Allows to retrieve location info for a GGUF field.

Parameters
keyGGUF field to retrieve
Returns
Retrieved location info as ReaderField

Definition at line 121 of file LLMGGUF.cs.

◆ GetGenericField()

byte[] LLMUnity.GGUFReader.GetGenericField ( string key)
inline

Allows to retrieve a single-valued GGUF field.

Parameters
keyGGUF field to retrieve
Returns
Retrieved location info as ReaderField

Definition at line 133 of file LLMGGUF.cs.

◆ GetIntField()

int LLMUnity.GGUFReader.GetIntField ( string key)
inline

Allows to retrieve an integer GGUF field.

Parameters
keyGGUF field to retrieve
Returns
Retrieved GGUF value

Definition at line 157 of file LLMGGUF.cs.

◆ GetStringField()

string LLMUnity.GGUFReader.GetStringField ( string key)
inline

Allows to retrieve a string GGUF field.

Parameters
keyGGUF field to retrieve
Returns
Retrieved GGUF value

Definition at line 145 of file LLMGGUF.cs.

Member Data Documentation

◆ fields

Dictionary<string, ReaderField> LLMUnity.GGUFReader.fields = new Dictionary<string, ReaderField>()

Dictionary of GGUF fields to location info.

Definition at line 77 of file LLMGGUF.cs.


The documentation for this class was generated from the following file: