Struct Training

Source

pub struct Training {
    pub parent: Config,
}

Expand description

Used to interact with the Training Endpoints.

Fields§

§parent: Config

Holds a reference to a Configuration struct, which contains the base url, auth token among other settings.

Implementations§

Source §

impl Training

Training struct contains all the functionality for interacting with the training endpoints of the Replicate API.

Source

pub fn new(rep: Config) -> Self

Create a new Training struct.

Source

pub fn create( &self, model_owner: &str, model_name: &str, version_id: &str, options: TrainingOptions, ) -> Result<CreateTraining, ReplicateError>

Create a new training.

§Arguments

model_owner - The name of the user or organization that owns the model.
model_name - The name of the model.
version_id - The ID of the version.
options - The options for creating a training.
- destination - A string representing the desired model to push to in the format {destination_model_owner}/{destination_model_name}. This should be an existing model owned by the user or organization making the API request. If the destination is invalid, the server returns an appropriate 4XX response.
- input - An object containing inputs to the Cog model’s train() function.
- webhook - An HTTPS URL for receiving a webhook when the training completes. The webhook will be a POST request where the request body is the same as the response body of the get training operation. If there are network problems, we will retry the webhook a few times, so make sure it can be safely called more than once.
_webhook_events_filter - TO only send specifc events to the webhook, use this field. If not specified, all events will be sent. The following events are supported:

§Example

use replicate_rust::{Replicate, config::Config, training::TrainingOptions};
use std::collections::HashMap;
 
let config = Config::default();
let replicate = Replicate::new(config);
 
let mut input = HashMap::new();
input.insert(String::from("training_data"), String::from("https://example.com/70k_samples.jsonl"));
 
let result = replicate.trainings.create(
   "owner",
   "model",
  "632231d0d49d34d5c4633bd838aee3d81d936e59a886fbf28524702003b4c532",
 TrainingOptions {
    destination: String::from("new_owner/new_name"),
    input,
    webhook: String::from("https://example.com/my-webhook"),
    _webhook_events_filter: None,
},
)?;

Source

pub fn get(&self, training_id: &str) -> Result<GetTraining, ReplicateError>

Get the details of a training.

§Arguments

training_id - The ID of the training you want to get.

§Example

use replicate_rust::{Replicate, config::Config};
 
let config = Config::default();
let replicate = Replicate::new(config);
 
let training = replicate.trainings.get("zz4ibbonubfz7carwiefibzgga")?;
println!("Training : {:?}", training);

Source

pub fn list(&self) -> Result<ListTraining, ReplicateError>

Get a paginated list of trainings that you’ve created with your account. Returns 100 records per page.

§Example

use replicate_rust::{Replicate, config::Config};
 
let config = Config::default();
let replicate = Replicate::new(config);
 
let trainings = replicate.trainings.list()?;
println!("Trainings : {:?}", trainings);

Source

pub fn cancel(&self, training_id: &str) -> Result<GetTraining, ReplicateError>

Cancel a training.

§Arguments

training_id - The ID of the training you want to cancel.

§Example

use replicate_rust::{Replicate, config::Config};
 
let config = Config::default();
let replicate = Replicate::new(config);
 
let result =  replicate.trainings.cancel("zz4ibbonubfz7carwiefibzgga")?;
println!("Result : {:?}", result);