summaryrefslogtreecommitdiff
path: root/candle-transformers/src/models/mobileclip.rs
diff options
context:
space:
mode:
authorzachcp <zachcp@users.noreply.github.com>2024-11-15 02:30:15 -0500
committerGitHub <noreply@github.com>2024-11-15 08:30:15 +0100
commitf689ce5d39c6f1475dfc71503288ea2905c8f685 (patch)
tree10b35ae68f1f5683edfebdcf92970de78ba05283 /candle-transformers/src/models/mobileclip.rs
parent0ed24b9852ccc7dfb92d555afba3d56c2a3f3224 (diff)
downloadcandle-f689ce5d39c6f1475dfc71503288ea2905c8f685.tar.gz
candle-f689ce5d39c6f1475dfc71503288ea2905c8f685.tar.bz2
candle-f689ce5d39c6f1475dfc71503288ea2905c8f685.zip
Documentation Pass for Models (#2617)
* links in chinese_clip * links for clip model * add mod docs for flux and llava * module doc for MMDIT and MIMI * add docs for a few more modesl * mod docs for bert naser and beit * add module docs for convmixer colpali codegeex and chatglm * add another series of moddocs * add fastvit-llama2_c * module docs mamba -> mobileone * module docs from moondream-phi3 * mod docs for quantized and qwen * update to yi * fix long names * Update llama2_c.rs * Update llama2_c_weights.rs * Fix the link for mimi + tweaks --------- Co-authored-by: Laurent Mazare <laurent.mazare@gmail.com>
Diffstat (limited to 'candle-transformers/src/models/mobileclip.rs')
-rw-r--r--candle-transformers/src/models/mobileclip.rs16
1 files changed, 16 insertions, 0 deletions
diff --git a/candle-transformers/src/models/mobileclip.rs b/candle-transformers/src/models/mobileclip.rs
index 45a5dbad..f0baf9e1 100644
--- a/candle-transformers/src/models/mobileclip.rs
+++ b/candle-transformers/src/models/mobileclip.rs
@@ -1,3 +1,19 @@
+//! Mobile CLIP model, combining a lightweight vision encoder with a text encoder
+//!
+//! A mobile-optimized CLIP implementation that uses:
+//! - FastViT as the vision encoder
+//! - OpenCLIP text encoder
+//! - Projection layers to align the feature spaces
+//!
+//! See model details at:
+//! - [FastViT](https://arxiv.org/abs/2303.14189)
+//! - [OpenCLIP](https://github.com/mlfoundations/open_clip)
+//!
+//! References:
+//! - [MobileVLM](https://huggingface.co/mobileVLM)
+//! - [MetaCLIP](https://arxiv.org/abs/2309.16671)
+//!
+
use super::fastvit;
use super::openclip::text_model;
use candle::{Result, Tensor, D};