You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

llama.native.safellavamodelhandle.md 3.7 kB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138
  1. # SafeLlavaModelHandle
  2. Namespace: LLama.Native
  3. A reference to a set of llava model weights.
  4. ```csharp
  5. public sealed class SafeLlavaModelHandle : SafeLLamaHandleBase, System.IDisposable
  6. ```
  7. Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [CriticalFinalizerObject](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.constrainedexecution.criticalfinalizerobject) → [SafeHandle](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.safehandle) → [SafeLLamaHandleBase](./llama.native.safellamahandlebase.md) → [SafeLlavaModelHandle](./llama.native.safellavamodelhandle.md)<br>
  8. Implements [IDisposable](https://docs.microsoft.com/en-us/dotnet/api/system.idisposable)
  9. ## Properties
  10. ### **IsInvalid**
  11. ```csharp
  12. public bool IsInvalid { get; }
  13. ```
  14. #### Property Value
  15. [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)<br>
  16. ### **IsClosed**
  17. ```csharp
  18. public bool IsClosed { get; }
  19. ```
  20. #### Property Value
  21. [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)<br>
  22. ## Methods
  23. ### **ReleaseHandle()**
  24. ```csharp
  25. protected bool ReleaseHandle()
  26. ```
  27. #### Returns
  28. [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)<br>
  29. ### **LoadFromFile(String, Int32)**
  30. Load a model from the given file path into memory
  31. ```csharp
  32. public static SafeLlavaModelHandle LoadFromFile(string modelPath, int verbosity)
  33. ```
  34. #### Parameters
  35. `modelPath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>
  36. MMP File (Multi-Modal Projections)
  37. `verbosity` [Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)<br>
  38. Verbosity level
  39. #### Returns
  40. [SafeLlavaModelHandle](./llama.native.safellavamodelhandle.md)<br>
  41. SafeHandle of the Clip Model
  42. #### Exceptions
  43. [InvalidOperationException](https://docs.microsoft.com/en-us/dotnet/api/system.invalidoperationexception)<br>
  44. [RuntimeError](./llama.exceptions.runtimeerror.md)<br>
  45. ### **CreateImageEmbeddings(LLamaContext, String)**
  46. Create the Image Embeddings.
  47. ```csharp
  48. public SafeLlavaImageEmbedHandle CreateImageEmbeddings(LLamaContext ctxLlama, string image)
  49. ```
  50. #### Parameters
  51. `ctxLlama` [LLamaContext](./llama.llamacontext.md)<br>
  52. LLama Context
  53. `image` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>
  54. Image filename (it supports jpeg format only)
  55. #### Returns
  56. [SafeLlavaImageEmbedHandle](./llama.native.safellavaimageembedhandle.md)<br>
  57. return the SafeHandle of these embeddings
  58. ### **CreateImageEmbeddings(LLamaContext, Byte[])**
  59. Create the Image Embeddings.
  60. ```csharp
  61. public SafeLlavaImageEmbedHandle CreateImageEmbeddings(LLamaContext ctxLlama, Byte[] image)
  62. ```
  63. #### Parameters
  64. `ctxLlama` [LLamaContext](./llama.llamacontext.md)<br>
  65. LLama Context
  66. `image` [Byte[]](https://docs.microsoft.com/en-us/dotnet/api/system.byte)<br>
  67. Image in binary format (it supports jpeg format only)
  68. #### Returns
  69. [SafeLlavaImageEmbedHandle](./llama.native.safellavaimageembedhandle.md)<br>
  70. return the SafeHandle of these embeddings
  71. ### **EvalImageEmbed(LLamaContext, SafeLlavaImageEmbedHandle, Int32&)**
  72. Evaluates the image embeddings.
  73. ```csharp
  74. public bool EvalImageEmbed(LLamaContext ctxLlama, SafeLlavaImageEmbedHandle imageEmbed, Int32& n_past)
  75. ```
  76. #### Parameters
  77. `ctxLlama` [LLamaContext](./llama.llamacontext.md)<br>
  78. Llama Context
  79. `imageEmbed` [SafeLlavaImageEmbedHandle](./llama.native.safellavaimageembedhandle.md)<br>
  80. The current embeddings to evaluate
  81. `n_past` [Int32&](https://docs.microsoft.com/en-us/dotnet/api/system.int32&)<br>
  82. #### Returns
  83. [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)<br>
  84. True on success