Struct Replicate

Source
pub struct Replicate {
    pub predictions: Prediction,
    pub models: Model,
    pub trainings: Training,
    pub collections: Collection,
    /* private fields */
}
Expand description

Rust Client for interacting with the Replicate API. Currently supports the following endpoints:

Fields§

§predictions: Prediction

Holds a reference to a Prediction struct. Use to run inference given model inputs and version.

§models: Model

Holds a reference to a Model struct. Use to get information about a model.

§trainings: Training

Holds a reference to a Training struct. Use to create a new training run.

§collections: Collection

Holds a reference to a Collection struct. Use to get and list model collections present in Replicate.

Implementations§

Source§

impl Replicate

Rust Client for interacting with the Replicate API.

Source

pub fn new(config: Config) -> Self

Create a new Replicate client.

§Example
use replicate_rust::{Replicate, config::Config};

let config = Config::default();
let replicate = Replicate::new(config);
Source

pub fn run<K: Serialize, V: Serialize>( &self, version: &str, inputs: HashMap<K, V>, ) -> Result<GetPrediction, ReplicateError>

Run a model with the given inputs in a blocking manner.

§Arguments
  • version - The version of the model to run.
  • inputs - The inputs to the model in the form of a HashMap.
§Example
use replicate_rust::{Replicate, config::Config};

let config = Config::default();
let replicate = Replicate::new(config);

// Construct the inputs.
let mut inputs = std::collections::HashMap::new();
inputs.insert("prompt", "a  19th century portrait of a wombat gentleman");

let version = "stability-ai/stable-diffusion:27b93a2413e7f36cd83da926f3656280b2931564ff050bf9575f1fdf9bcd7478";

// Run the model.
let result = replicate.run(version, inputs)?;

println!("Output : {:?}", result.output);

Trait Implementations§

Source§

impl Clone for Replicate

Source§

fn clone(&self) -> Replicate

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Replicate

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,