LLM for Unity  v3.0.3
Create characters in Unity with LLMs!
Loading...
Searching...
No Matches
Static Public Member Functions | Static Public Attributes | List of all members
LLMUnity.LLMUnitySetup Class Reference
Utils

Class implementing helper functions for setup and process management. More...

Static Public Member Functions

static void AddErrorCallBack (Action< string > callback)
 Add callback function to call for error logs.
 
static void RemoveErrorCallBack (Action< string > callback)
 Remove callback function added for error logs.
 
static void ClearErrorCallBacks ()
 Remove all callback function added for error logs.
 
static int GetMaxFreqKHz (int cpuId)
 
static bool IsSmtCpu (int cpuId)
 
static int AndroidGetNumBigCores ()
 Calculates the number of big cores in Android similarly to ncnn (https://github.com/Tencent/ncnn)
 
static int AndroidGetNumBigCoresCapacity ()
 Calculates the number of big cores in Android similarly to Unity (https://docs.unity3d.com/2022.3/Documentation/Manual/android-thread-configuration.html)
 

Static Public Attributes

static string Version = "v3.0.3"
 LLM for Unity version.
 
static string LlamaLibVersion = "v2.0.5"
 LlamaLib version.
 
static string LlamaLibReleaseURL = $"https://github.com/undreamai/LlamaLib/releases/download/{LlamaLibVersion}"
 LlamaLib release url.
 
static string libraryName = $"LlamaLib-{LlamaLibVersion}"
 LlamaLib name.
 
static string libraryPath = GetAssetPath(libraryName)
 LlamaLib path.
 
static string LlamaLibURL = $"{LlamaLibReleaseURL}/{libraryName}.zip"
 LlamaLib url.
 
static string LLMUnityStore = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), "LLMUnity")
 LLMnity store path.
 
static string modelDownloadPath = Path.Combine(LLMUnityStore, "models")
 Model download path.
 
static string cacheDownloadPath = Path.Combine(LLMUnityStore, "cache")
 cache download path
 
static string cacheZipPath = Path.Combine(cacheDownloadPath, Path.GetFileName(LlamaLibURL))
 
static string cacheZipHashPath = cacheZipPath + ".sha256"
 
static string LLMManagerPath = GetAssetPath("LLMManager.json")
 Path of file with build information for runtime.
 
static readonly Dictionary< string,(string, string, string)[]> modelOptions
 Default models for download.
 

Detailed Description

Class implementing helper functions for setup and process management.

Definition at line 97 of file LLMUnitySetup.cs.

Member Function Documentation

◆ AddErrorCallBack()

static void LLMUnity.LLMUnitySetup.AddErrorCallBack ( Action< string > callback)
inlinestatic

Add callback function to call for error logs.

Definition at line 599 of file LLMUnitySetup.cs.

◆ AndroidGetNumBigCores()

static int LLMUnity.LLMUnitySetup.AndroidGetNumBigCores ( )
inlinestatic

Calculates the number of big cores in Android similarly to ncnn (https://github.com/Tencent/ncnn)

Returns

Definition at line 680 of file LLMUnitySetup.cs.

◆ AndroidGetNumBigCoresCapacity()

static int LLMUnity.LLMUnitySetup.AndroidGetNumBigCoresCapacity ( )
inlinestatic

Calculates the number of big cores in Android similarly to Unity (https://docs.unity3d.com/2022.3/Documentation/Manual/android-thread-configuration.html)

Returns

Definition at line 734 of file LLMUnitySetup.cs.

◆ ClearErrorCallBacks()

static void LLMUnity.LLMUnitySetup.ClearErrorCallBacks ( )
inlinestatic

Remove all callback function added for error logs.

Definition at line 611 of file LLMUnitySetup.cs.

◆ GetMaxFreqKHz()

static int LLMUnity.LLMUnitySetup.GetMaxFreqKHz ( int cpuId)
inlinestatic

Definition at line 616 of file LLMUnitySetup.cs.

◆ IsSmtCpu()

static bool LLMUnity.LLMUnitySetup.IsSmtCpu ( int cpuId)
inlinestatic

Definition at line 650 of file LLMUnitySetup.cs.

◆ RemoveErrorCallBack()

static void LLMUnity.LLMUnitySetup.RemoveErrorCallBack ( Action< string > callback)
inlinestatic

Remove callback function added for error logs.

Definition at line 605 of file LLMUnitySetup.cs.

Member Data Documentation

◆ cacheDownloadPath

string LLMUnity.LLMUnitySetup.cacheDownloadPath = Path.Combine(LLMUnityStore, "cache")
static

cache download path

Definition at line 117 of file LLMUnitySetup.cs.

◆ cacheZipHashPath

string LLMUnity.LLMUnitySetup.cacheZipHashPath = cacheZipPath + ".sha256"
static

Definition at line 119 of file LLMUnitySetup.cs.

◆ cacheZipPath

string LLMUnity.LLMUnitySetup.cacheZipPath = Path.Combine(cacheDownloadPath, Path.GetFileName(LlamaLibURL))
static

Definition at line 118 of file LLMUnitySetup.cs.

◆ libraryName

string LLMUnity.LLMUnitySetup.libraryName = $"LlamaLib-{LlamaLibVersion}"
static

LlamaLib name.

Definition at line 107 of file LLMUnitySetup.cs.

◆ libraryPath

string LLMUnity.LLMUnitySetup.libraryPath = GetAssetPath(libraryName)
static

LlamaLib path.

Definition at line 109 of file LLMUnitySetup.cs.

◆ LlamaLibReleaseURL

string LLMUnity.LLMUnitySetup.LlamaLibReleaseURL = $"https://github.com/undreamai/LlamaLib/releases/download/{LlamaLibVersion}"
static

LlamaLib release url.

Definition at line 105 of file LLMUnitySetup.cs.

◆ LlamaLibURL

string LLMUnity.LLMUnitySetup.LlamaLibURL = $"{LlamaLibReleaseURL}/{libraryName}.zip"
static

LlamaLib url.

Definition at line 111 of file LLMUnitySetup.cs.

◆ LlamaLibVersion

string LLMUnity.LLMUnitySetup.LlamaLibVersion = "v2.0.5"
static

LlamaLib version.

Definition at line 103 of file LLMUnitySetup.cs.

◆ LLMManagerPath

string LLMUnity.LLMUnitySetup.LLMManagerPath = GetAssetPath("LLMManager.json")
static

Path of file with build information for runtime.

Definition at line 121 of file LLMUnitySetup.cs.

◆ LLMUnityStore

string LLMUnity.LLMUnitySetup.LLMUnityStore = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), "LLMUnity")
static

LLMnity store path.

Definition at line 113 of file LLMUnitySetup.cs.

◆ modelDownloadPath

string LLMUnity.LLMUnitySetup.modelDownloadPath = Path.Combine(LLMUnityStore, "models")
static

Model download path.

Definition at line 115 of file LLMUnitySetup.cs.

◆ modelOptions

readonly Dictionary<string, (string, string, string)[]> LLMUnity.LLMUnitySetup.modelOptions
static

Default models for download.

Definition at line 125 of file LLMUnitySetup.cs.

◆ Version

string LLMUnity.LLMUnitySetup.Version = "v3.0.3"
static

LLM for Unity version.

Definition at line 101 of file LLMUnitySetup.cs.

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