Skip to main content

ESMCRunner

Struct ESMCRunner 

Source
pub struct ESMCRunner { /* private fields */ }
Expand description

Wraps a loaded ESMC model for sequence embedding inference.

Implementations§

Source§

impl ESMCRunner

Source

pub fn from_pretrained(model: ESMCModels, device: Device) -> Result<Self>

Download weights from HuggingFace and load the model.

Handles the ESMCForMaskedLM wrapper prefix (esmc.) transparently: probes for esmc.embed.weight in the safetensors and sets the VarBuilder root to vb.pp("esmc") when found, otherwise uses the flat (unwrapped) layout.

Source

pub fn from_pretrained_with( model: ESMCModels, opts: &LoadOptions, ) -> Result<Self>

Load with an explicit device and dtype.

ESMC6B is ~24 GB at F32 but ~12 GB at BF16 — its on-disk precision — so reduced precision is the difference between loadable and not on a 32 GB machine. See tests/test_plm_dtype_parity.rs for the numerical cost (ferritin-100.9).

Source

pub fn embed_sequence(&self, sequence: &str) -> Result<Tensor>

Tokenize sequence and run a forward pass.

Returns per-residue embeddings with shape (1, L, d_model) where L includes the BOS and EOS tokens added by the tokenizer.

Trait Implementations§

Source§

impl PlmRunner for ESMCRunner

Source§

fn embed(&self, sequence: &str) -> Result<Tensor>

Delegate to embed_sequence, returning per-residue embeddings (1, L, d_model).

Source§

fn special_tokens(&self) -> SpecialTokenLayout

ESMC::encode calls tokenize_sequence(.., true), which wraps the sequence in BOS and EOS.

Source§

fn logits(&self, sequence: &str) -> Result<Tensor>

Sequence logits (1, L + 2, vocab_size).

Source§

fn embed_batch(&self, sequences: &[&str]) -> Result<Tensor>

One batched forward pass over right-padded sequences (ferritin-100.12).

ESM-C’s sequence_id is a where_cond predicate — 1 keeps a key, 0 replaces its score with -inf — so the U8 mask goes in as-is. It is passed explicitly rather than relying on ESMC::forward’s fallback (tokens.ne(pad_id)), which would happen to agree here but ties correctness to the padding id rather than to the batch itself.

Source§

fn model_name(&self) -> &str

Model name / identifier string (e.g. “esm2”, “amplify”, “esmc”).
Source§

fn metadata(&self) -> ModelMetadata

Architecture dimensions, for sizing downstream layers.
Source§

fn device(&self) -> &Device

Device the model’s weights live on.
Source§

fn residue_count(&self, sequence: &str) -> usize

How many residues sequence encodes. Read more
Source§

fn embed_residues(&self, sequence: &str) -> Result<Tensor>

Per-residue embeddings with special-token rows removed. Read more
Source§

fn embed_residues_batch(&self, sequences: &[&str]) -> Result<Tensor>

Per-residue embeddings for a batch, special-token rows removed. 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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> DropFlavorWrapper<T> for T

§

type Flavor = MayDrop

The DropFlavor that [wrap]s T into Self
§

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

§

const WITNESS: W = W::MAKE

A constant of the type witness
§

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

§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
§

impl<T> Instrument for T

§

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

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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