popsam-core 0.1.0

Core library for AI-assisted selection of semantically representative texts
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

//! Core library for selecting semantically representative texts from a larger collection.
//!
//! The public API is organized around three concerns:
//! - input and result data models in [`model`]
//! - embedding providers in [`embedding`]
//! - the elimination algorithm in [`election`]

#![deny(missing_docs)]

/// Embedding provider traits and implementations.
pub mod embedding;
/// Election configuration and execution.
pub mod election;
/// Error types returned by the library.
pub mod error;
/// Serializable data models used by the public API.
pub mod model;

pub use embedding::{
    CandleEmbeddingModelFiles, CandleEmbeddingModelSpec, CandleEmbeddingProvider, EmbeddingProvider,
    OpenAiCompatibleEmbeddingProvider,
};
pub use election::{run_election, ElectionConfig};
pub use error::{PopsamError, PopsamResult};
pub use model::{
    CandidateRoundVotes, EmbeddedText, EmbeddedTextInput, ElectionResult, InputRecord, RoundSummary,
};