Skip to content

Commit

Permalink
Fix doc warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
boswelja committed Jan 21, 2025
1 parent 3c559cc commit 6f79fa1
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion rust/src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ pub struct TextEmbedConfig {
/// Defaults to [SplittingStrategy::Sentence]
pub splitting_strategy: Option<SplittingStrategy>,
/// Allows overriding the embedder used when the splitting strategy is
/// [SplittingStrategy::Semantic]. Defaults to [JinaEmbedder::default()].
/// [SplittingStrategy::Semantic]. Defaults to JINA.
pub semantic_encoder: Option<Arc<Embedder>>,
/// When embedding a PDF, controls whether **o**ptical **c**haracter **r**ecognition is used on
/// the PDF to extract text. This process involves rendering the PDF as a series of images, and
Expand Down
2 changes: 1 addition & 1 deletion rust/src/embeddings/cloud/cohere.rs
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ impl CohereEmbedder {
///
/// # Arguments
///
/// * `model` - A string slice that holds the model to be used for embedding. Find available models at https://docs.cohere.com/docs/cohere-embed
/// * `model` - A string slice that holds the model to be used for embedding. Find available models at <https://docs.cohere.com/docs/cohere-embed>
/// * `api_key` - An optional string slice that holds the API key for authenticating requests to the Cohere API.
///
/// # Returns
Expand Down
4 changes: 2 additions & 2 deletions rust/src/embeddings/embed.rs
Original file line number Diff line number Diff line change
Expand Up @@ -198,8 +198,8 @@ impl TextEmbedder {
/// - "cohere"
///
/// * `model_id` - A string holds the model ID for the model to be used for embedding.
/// - For OpenAI, find available models at https://platform.openai.com/docs/guides/embeddings/embedding-models
/// - For Cohere, find available models at https://docs.cohere.com/docs/cohere-embed
/// - For OpenAI, find available models at <https://platform.openai.com/docs/guides/embeddings/embedding-models>
/// - For Cohere, find available models at <https://docs.cohere.com/docs/cohere-embed>
/// * `api_key` - An optional string holds the API key for authenticating requests to the Cohere API. If not provided, it is taken from the environment variable
/// - For OpenAI, create environment variable `OPENAI_API_KEY`
/// - For Cohere, create environment variable `CO_API_KEY`
Expand Down
4 changes: 2 additions & 2 deletions rust/src/models/clip/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
//! Contrastive Language-Image Pre-Training (CLIP) is an architecture trained on
//! pairs of images with related texts.
//!
//! https://github.com/openai/CLIP
//! https://github.com/huggingface/transformers/tree/f6fa0f0bf0796ac66f201f23bdb8585de1609add/src/transformers/models/clip
//! <https://github.com/openai/CLIP>
//! <https://github.com/huggingface/transformers/tree/f6fa0f0bf0796ac66f201f23bdb8585de1609add/src/transformers/models/clip>
use self::{
text_model::{Activation, ClipTextTransformer},
vision_model::ClipVisionTransformer,
Expand Down
4 changes: 2 additions & 2 deletions rust/src/models/clip/text_model.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
//! Contrastive Language-Image Pre-Training (CLIP) is an architecture trained on
//! pairs of images with related texts.
//!
//! https://github.com/openai/CLIP
//! https://github.com/huggingface/transformers/tree/f6fa0f0bf0796ac66f201f23bdb8585de1609add/src/transformers/models/clip
//! <https://github.com/openai/CLIP>
//! <https://github.com/huggingface/transformers/tree/f6fa0f0bf0796ac66f201f23bdb8585de1609add/src/transformers/models/clip>
use candle_core::{DType, Device, IndexOp, Result, Tensor, D};
use candle_nn as nn;
Expand Down
4 changes: 2 additions & 2 deletions rust/src/models/clip/vision_model.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
//! Contrastive Language-Image Pre-Training (CLIP) is an architecture trained on
//! pairs of images with related texts.
//!
//! https://github.com/openai/CLIP
//! https://github.com/huggingface/transformers/tree/f6fa0f0bf0796ac66f201f23bdb8585de1609add/src/transformers/models/clip
//! <https://github.com/openai/CLIP>
//! <https://github.com/huggingface/transformers/tree/f6fa0f0bf0796ac66f201f23bdb8585de1609add/src/transformers/models/clip>
use candle_core::{IndexOp, Result, Shape, Tensor, D};
use candle_nn as nn;
Expand Down

0 comments on commit 6f79fa1

Please sign in to comment.