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 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
//! Used to interact with the [Training Endpoints](https://replicate.com/docs/reference/http#trainings.create).
//!
//!
//! # Example
//!
//! ```
//! use replicate_rust::{Replicate, config::Config};
//!
//! let config = Config::default();
//! let replicate = Replicate::new(config);
//!
//! let mut input = HashMap::new();
//! input.insert(String::from("train_data"), String::from("https://example.com/70k_samples.jsonl"));
//!
//! let result = replicate.trainings.create(
//! String::from("owner"),
//! String::from("model"),
//! String::from("632231d0d49d34d5c4633bd838aee3d81d936e59a886fbf28524702003b4c532"),
//! TrainingOptions {
//! destination: String::from("{new_owner}/{new_name}"),
//! input,
//! webhook: String::from("https://example.com/my-webhook"),
//! _webhook_events_filter: None,
//! },
//! );
//!
//! ```
//!
//!
use std::collections::HashMap;
use crate::api_definitions::{CreateTraining, GetTraining, ListTraining, WebhookEvents};
/// Contains all the options for creating a training.
pub struct TrainingOptions {
pub destination: String,
pub input: HashMap<String, String>,
pub webhook: String,
_webhook_events_filter: Option<WebhookEvents>,
}
/// Data to be sent to the API when creating a training.
#[derive(Debug, serde::Serialize, serde::Deserialize)]
pub struct CreateTrainingPayload {
pub destination: String,
pub input: HashMap<String, String>,
pub webhook: String,
}
// #[derive(Clone)]
pub struct Training {
// Holds a reference to a Replicate
pub parent: crate::config::Config,
}
/// Training struct contains all the functionality for interacting with the training endpoints of the Replicate API.
impl Training {
pub fn new(rep: crate::config::Config) -> Self {
Self { parent: rep }
}
/// 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};
///
/// 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(
/// String::from("owner"),
/// String::from("model"),
/// String::from("632231d0d49d34d5c4633bd838aee3d81d936e59a886fbf28524702003b4c532"),
/// TrainingOptions {
/// destination: String::from({new_owner}/{new_name}),
/// input,
/// webhook: String::from("https://example.com/my-webhook"),
/// _webhook_events_filter: None,
/// },
/// );
/// ```
///
pub fn create(
&self,
model_owner: String,
model_name: String,
version_id: String,
options: TrainingOptions,
) -> Result<CreateTraining, Box<dyn std::error::Error>> {
let client = reqwest::blocking::Client::new();
let payload = CreateTrainingPayload {
destination: options.destination,
input: options.input,
webhook: options.webhook,
};
let response = client
.post(format!(
"{}/models/{}/{}/versions/{}/trainings",
self.parent.base_url, model_owner, model_name, version_id,
))
.header("Authorization", format!("Token {}", self.parent.auth))
.header("User-Agent", &self.parent.user_agent)
.json(&payload)
.send()?;
let response_string = response.text()?;
let response_struct: CreateTraining = serde_json::from_str(&response_string)?;
Ok(response_struct)
}
/// 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);
///
/// match replicate.trainings.get(String::from("zz4ibbonubfz7carwiefibzgga")) {
/// Ok(result) => println!("Success : {:?}", result),
/// Err(e) => println!("Error : {}", e),
/// };
/// ```
pub fn get(&self, training_id: String) -> Result<GetTraining, Box<dyn std::error::Error>> {
let client = reqwest::blocking::Client::new();
let response = client
.get(format!(
"{}/trainings/{}",
self.parent.base_url, training_id,
))
.header("Authorization", format!("Token {}", self.parent.auth))
.header("User-Agent", &self.parent.user_agent)
.send()?;
let response_string = response.text()?;
let response_struct: GetTraining = serde_json::from_str(&response_string)?;
Ok(response_struct)
}
/// 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);
///
/// match replicate.trainings.list() {
/// Ok(result) => println!("Success : {:?}", result),
/// Err(e) => println!("Error : {}", e),
/// };
/// ```
pub fn list(&self) -> Result<ListTraining, Box<dyn std::error::Error>> {
let client = reqwest::blocking::Client::new();
let response = client
.get(format!("{}/trainings", self.parent.base_url,))
.header("Authorization", format!("Token {}", self.parent.auth))
.header("User-Agent", &self.parent.user_agent)
.send()?;
let response_string = response.text()?;
let response_struct: ListTraining = serde_json::from_str(&response_string)?;
Ok(response_struct)
}
/// 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);
///
/// match replicate.trainings.cancel(String::from("zz4ibbonubfz7carwiefibzgga")) {
/// Ok(result) => println!("Success : {:?}", result),
/// Err(e) => println!("Error : {}", e),
/// };
/// ```
pub fn cancel(&self, training_id: String) -> Result<GetTraining, Box<dyn std::error::Error>> {
let client = reqwest::blocking::Client::new();
let response = client
.post(format!(
"{}/trainings/{}/cancel",
self.parent.base_url, training_id
))
.header("Authorization", format!("Token {}", self.parent.auth))
.header("User-Agent", &self.parent.user_agent)
.send()?;
let response_string = response.text()?;
let response_struct: GetTraining = serde_json::from_str(&response_string)?;
Ok(response_struct)
}
}
#[cfg(test)]
mod tests {
use crate::{api_definitions::PredictionStatus, config::Config, Replicate};
use super::*;
use httpmock::{
Method::{GET, POST},
MockServer,
};
use serde_json::json;
#[test]
fn test_create() -> Result<(), Box<dyn std::error::Error>> {
let server = MockServer::start();
let post_mock = server.mock(|when, then| {
when.method(POST).path("/models/owner/model/versions/632231d0d49d34d5c4633bd838aee3d81d936e59a886fbf28524702003b4c532/trainings");
then.status(200).json_body_obj(&json!( {
"id": "zz4ibbonubfz7carwiefibzgga",
"version": "{version}",
"status": "starting",
"input": {
"text": "...",
},
"output": None::<String>,
"error": None::<String>,
"logs": None::<String>,
"started_at": None::<String>,
"created_at": "2023-03-28T21:47:58.566434Z",
"completed_at": None::<String>,
}
));
});
let config = Config {
auth: String::from("test"),
base_url: server.base_url(),
..Config::default()
};
let replicate = Replicate::new(config);
let mut input = HashMap::new();
input.insert(String::from("text"), String::from("..."));
let result = replicate.trainings.create(
String::from("owner"),
String::from("model"),
String::from("632231d0d49d34d5c4633bd838aee3d81d936e59a886fbf28524702003b4c532"),
TrainingOptions {
destination: String::from("new_owner/new_model"),
input,
webhook: String::from("webhook"),
_webhook_events_filter: None,
},
);
assert_eq!(result?.id, "zz4ibbonubfz7carwiefibzgga");
// Ensure the mocks were called as expected
post_mock.assert();
Ok(())
}
#[test]
fn test_get() -> Result<(), Box<dyn std::error::Error>> {
let server = MockServer::start();
let get_mock = server.mock(|when, then| {
when.method(GET)
.path("/trainings/zz4ibbonubfz7carwiefibzgga");
then.status(200).json_body_obj(&json!( {
"id": "zz4ibbonubfz7carwiefibzgga",
"version": "{version}",
"status": "succeeded",
"input": {
"text": "...",
"param" : "..."
},
"output": {
"version": "...",
},
"error": None::<String>,
"logs": None::<String>,
"webhook_completed": None::<String>,
"started_at": None::<String>,
"created_at": "2023-03-28T21:47:58.566434Z",
"completed_at": None::<String>,
}
));
});
let config = Config {
auth: String::from("test"),
base_url: server.base_url(),
..Config::default()
};
let replicate = Replicate::new(config);
let result = replicate
.trainings
.get(String::from("zz4ibbonubfz7carwiefibzgga"));
assert_eq!(result?.status, PredictionStatus::succeeded);
// Ensure the mocks were called as expected
get_mock.assert();
Ok(())
}
#[test]
fn test_cancel() -> Result<(), Box<dyn std::error::Error>> {
let server = MockServer::start();
let get_mock = server.mock(|when, then| {
when.method(POST)
.path("/trainings/zz4ibbonubfz7carwiefibzgga/cancel");
then.status(200).json_body_obj(&json!( {
"id": "zz4ibbonubfz7carwiefibzgga",
"version": "{version}",
"status": "canceled",
"input": {
"text": "...",
"param1" : "..."
},
"output": {
"version": "...",
},
"error": None::<String>,
"logs": None::<String>,
"webhook_completed": None::<String>,
"started_at": None::<String>,
"created_at": "2023-03-28T21:47:58.566434Z",
"completed_at": None::<String>,
}
));
});
let config = Config {
auth: String::from("test"),
base_url: server.base_url(),
..Config::default()
};
let replicate = Replicate::new(config);
let result = replicate
.trainings
.cancel(String::from("zz4ibbonubfz7carwiefibzgga"))?;
assert_eq!(result.status, PredictionStatus::canceled);
// Ensure the mocks were called as expected
get_mock.assert();
Ok(())
}
#[test]
fn test_list() -> Result<(), Box<dyn std::error::Error>> {
let server = MockServer::start();
let get_mock = server.mock(|when, then| {
when.method(GET).path("/trainings");
then.status(200).json_body_obj(&json!( {
"next": "https://api.replicate.com/v1/trainings?cursor=cD0yMDIyLTAxLTIxKzIzJTNBMTglM0EyNC41MzAzNTclMkIwMCUzQTAw",
"previous": None::<String>,
"results": [
{
"id": "jpzd7hm5gfcapbfyt4mqytarku",
"version": "b21cbe271e65c1718f2999b038c18b45e21e4fba961181fbfae9342fc53b9e05",
"urls": {
"get": "https://api.replicate.com/v1/trainings/jpzd7hm5gfcapbfyt4mqytarku",
"cancel": "https://api.replicate.com/v1/trainings/jpzd7hm5gfcapbfyt4mqytarku/cancel"
},
"created_at": "2022-04-26T20:00:40.658234Z",
"started_at": "2022-04-26T20:00:84.583803Z",
"completed_at": "2022-04-26T20:02:27.648305Z",
"source": "web",
"status": "succeeded"
}
]
}
));
});
let config = Config {
auth: String::from("test"),
base_url: server.base_url(),
..Config::default()
};
let replicate = Replicate::new(config);
let result = replicate.trainings.list()?;
assert_eq!(result.results.len(), 1);
assert_eq!(result.results[0].id, "jpzd7hm5gfcapbfyt4mqytarku");
// Ensure the mocks were called as expected
get_mock.assert();
Ok(())
}
}