From 5a9155189945cd9aa6b98a4a340b38dc93c8d219 Mon Sep 17 00:00:00 2001 From: Damian Stewart Date: Sun, 15 Oct 2023 17:25:13 +0200 Subject: [PATCH] update headerdoc --- llava/clip.h | 7 ++++--- llava/llava.h | 7 +++++-- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/llava/clip.h b/llava/clip.h index a8022c524..8dfa97e12 100644 --- a/llava/clip.h +++ b/llava/clip.h @@ -21,9 +21,10 @@ struct clip_vision_hparams { float eps; }; -struct clip_ctx * clip_model_load(const char * fname, const int verbosity); - -void clip_free(struct clip_ctx * ctx); +/** load mmproj model */ +LLAMA_API struct clip_ctx * clip_model_load(const char * fname, const int verbosity); +/** free mmproj model */ +LLAMA_API void clip_free(struct clip_ctx * ctx); size_t clip_embd_nbytes(const struct clip_ctx * ctx); int clip_n_patches(const struct clip_ctx * ctx); diff --git a/llava/llava.h b/llava/llava.h index aa9ea1a4f..637fe4c09 100644 --- a/llava/llava.h +++ b/llava/llava.h @@ -15,14 +15,17 @@ struct llava_image_embed { int n_image_pos; }; +/** sanity check for clip <-> llava embed size match */ LLAMA_API bool llava_validate_embed_size(const llama_context * ctx_llama, const clip_ctx * ctx_clip); +/** build an image embed from image file bytes */ LLAMA_API struct llava_image_embed * llava_image_embed_make_with_bytes(struct clip_ctx * ctx_clip, int n_threads, const unsigned char * image_bytes, int image_bytes_length); +/** build an image embed from a path to an image filename */ LLAMA_API struct llava_image_embed * llava_image_embed_make_with_filename(struct clip_ctx * ctx_clip, int n_threads, const char * image_path); LLAMA_API void llava_image_embed_free(struct llava_image_embed * embed); +/** free an embedding made with llava_image_embed_make_* */ -/** write the image represented by embed into the llama context with batch size n_batch, - * starting at context pos n_past. on completion, n_past points to the next position in the context after the image embed. */ +/** write the image represented by embed into the llama context with batch size n_batch, starting at context pos n_past. on completion, n_past points to the next position in the context after the image embed. */ LLAMA_API bool llava_eval_image_embed(struct llama_context * ctx_llama, const struct llava_image_embed * embed, int n_batch, int * n_past);