Struct LMBuilder 

pub struct LMBuilder<S: State = Empty> { /* private fields */ }

Use builder syntax to set the inputs and finish with build().

Implementations

impl<S: State> LMBuilder<S>

pub fn build(self) -> LM

where S: IsComplete,

Finish building and return the requested object

Examples found in repository

examples/01-simple.rs (line 79)

async fn main() {
    configure(
        LM::builder()
            .api_key(SecretString::from(std::env::var("OPENAI_API_KEY").unwrap()))
            .build(),
        ChatAdapter,
    );

    let example = example! {
        "question": "input" => "What is the capital of France?",
    };

    let qa_rater = QARater::builder().build();
    let prediction = qa_rater.forward(example).await.unwrap();
    println!("{prediction:?}");
}

examples/03-evaluate-hotpotqa.rs (line 63)

async fn main() -> anyhow::Result<()> {
    configure(
        LM::builder()
            .api_key(SecretString::from(std::env::var("OPENAI_API_KEY")?))
            .build(),
        ChatAdapter {},
    );

    let examples = DataLoader::load_hf(
        "hotpotqa/hotpot_qa",
        vec!["question".to_string()],
        vec!["answer".to_string()],
        "fullwiki",
        "validation",
        true,
    )?[..10]
        .to_vec();

    let evaluator = QARater::builder().build();
    let metric = evaluator.evaluate(examples).await;

    println!("Metric: {metric}");
    Ok(())
}

examples/04-optimize-hotpotqa.rs (line 63)

async fn main() -> anyhow::Result<()> {
    configure(
        LM::builder()
            .api_key(SecretString::from(std::env::var("OPENAI_API_KEY")?))
            .build(),
        ChatAdapter {},
    );

    let examples = DataLoader::load_hf(
        "hotpotqa/hotpot_qa",
        vec!["question".to_string()],
        vec!["answer".to_string()],
        "fullwiki",
        "validation",
        true,
    )?[..10]
        .to_vec();

    let mut rater = QARater::builder().build();
    let optimizer = COPRO::builder().breadth(10).depth(1).build();

    println!("Rater: {:?}", rater.answerer.get_signature().instruction());

    optimizer.compile(&mut rater, examples.clone()).await?;

    println!("Rater: {:?}", rater.answerer.get_signature().instruction());

    Ok(())
}

pub fn api_key(self, value: SecretString) -> LMBuilder<SetApiKey<S>>

where S::ApiKey: IsUnset,

Required.

Examples found in repository

examples/01-simple.rs (line 78)

async fn main() {
    configure(
        LM::builder()
            .api_key(SecretString::from(std::env::var("OPENAI_API_KEY").unwrap()))
            .build(),
        ChatAdapter,
    );

    let example = example! {
        "question": "input" => "What is the capital of France?",
    };

    let qa_rater = QARater::builder().build();
    let prediction = qa_rater.forward(example).await.unwrap();
    println!("{prediction:?}");
}

examples/03-evaluate-hotpotqa.rs (line 62)

async fn main() -> anyhow::Result<()> {
    configure(
        LM::builder()
            .api_key(SecretString::from(std::env::var("OPENAI_API_KEY")?))
            .build(),
        ChatAdapter {},
    );

    let examples = DataLoader::load_hf(
        "hotpotqa/hotpot_qa",
        vec!["question".to_string()],
        vec!["answer".to_string()],
        "fullwiki",
        "validation",
        true,
    )?[..10]
        .to_vec();

    let evaluator = QARater::builder().build();
    let metric = evaluator.evaluate(examples).await;

    println!("Metric: {metric}");
    Ok(())
}

examples/04-optimize-hotpotqa.rs (line 62)

async fn main() -> anyhow::Result<()> {
    configure(
        LM::builder()
            .api_key(SecretString::from(std::env::var("OPENAI_API_KEY")?))
            .build(),
        ChatAdapter {},
    );

    let examples = DataLoader::load_hf(
        "hotpotqa/hotpot_qa",
        vec!["question".to_string()],
        vec!["answer".to_string()],
        "fullwiki",
        "validation",
        true,
    )?[..10]
        .to_vec();

    let mut rater = QARater::builder().build();
    let optimizer = COPRO::builder().breadth(10).depth(1).build();

    println!("Rater: {:?}", rater.answerer.get_signature().instruction());

    optimizer.compile(&mut rater, examples.clone()).await?;

    println!("Rater: {:?}", rater.answerer.get_signature().instruction());

    Ok(())
}

pub fn base_url(self, value: String) -> LMBuilder<SetBaseUrl<S>>

where S::BaseUrl: IsUnset,

Optional (Some / Option setters). Default: "https://api.openai.com/v1".to_string().

pub fn maybe_base_url(self, value: Option<String>) -> LMBuilder<SetBaseUrl<S>>

where S::BaseUrl: IsUnset,

Optional (Some / Option setters). Default: "https://api.openai.com/v1".to_string().

pub fn config(self, value: LMConfig) -> LMBuilder<SetConfig<S>>

where S::Config: IsUnset,

Optional (Some / Option setters). Default: LMConfig::default().

pub fn maybe_config(self, value: Option<LMConfig>) -> LMBuilder<SetConfig<S>>

where S::Config: IsUnset,

Optional (Some / Option setters). Default: LMConfig::default().

pub fn history(self, value: Vec<LMResponse>) -> LMBuilder<SetHistory<S>>

where S::History: IsUnset,

Optional (Some / Option setters). Default: Vec::new().

pub fn maybe_history( self, value: Option<Vec<LMResponse>>, ) -> LMBuilder<SetHistory<S>>

where S::History: IsUnset,

Optional (Some / Option setters). Default: Vec::new().

pub fn client(self, value: Client<OpenAIConfig>) -> LMBuilder<SetClient<S>>

where S::Client: IsUnset,

Optional (Some / Option setters).

pub fn maybe_client( self, value: Option<Client<OpenAIConfig>>, ) -> LMBuilder<SetClient<S>>

where S::Client: IsUnset,

Optional (Some / Option setters).