pub struct BoundNamespaces<'a> { /* private fields */ }Expand description
The checkpoint namespaces a task wrapper binds for itself.
§Why strictness has to be contextual
A bare encoder load has to tolerate whole head namespaces: HuggingFace ships
cls.predictions.*, classifier.* and qa_outputs.* inside the same file
as the encoder, so BertModel::load_from_checkpoint would fail on every real
bert-base-uncased checkpoint if it refused them. That tolerance lives in
each architecture’s ALLOWED_UNUSED_PREFIXES.
A task wrapper is in the opposite position. It binds those very namespaces,
so an entry left over inside one is not “a head this model does not have” —
it is a name this model failed to recognise. Under the encoder’s policy alone
a typo such as cls.predictions.transform.dens.weight starts with cls.,
lands in LoadReport::ignored, and the load reports success while the
dense layer silently keeps its random initialisation.
BoundNamespaces::verify closes exactly that gap: after the wrapper has
bound its head, every checkpoint entry still unconsumed inside a namespace
the wrapper claims becomes an error, while namespaces it does not claim stay
as tolerant as before. A wrapper that claims cls.predictions. therefore
still accepts a checkpoint’s cls.seq_relationship.* NSP head, and a
checkpoint with no head at all still loads (nothing is left over — the gap is
reported through LoadReport::missing instead).
Implementations§
Source§impl<'a> BoundNamespaces<'a>
impl<'a> BoundNamespaces<'a>
Sourcepub const fn new(prefixes: &'a [&'a str]) -> Self
pub const fn new(prefixes: &'a [&'a str]) -> Self
Claim a set of namespaces with no buffer exceptions.
Sourcepub const fn with_tolerated_suffixes(
prefixes: &'a [&'a str],
tolerated_suffixes: &'a [&'a str],
) -> Self
pub const fn with_tolerated_suffixes( prefixes: &'a [&'a str], tolerated_suffixes: &'a [&'a str], ) -> Self
Claim namespaces, excepting registered buffers matched by suffix.
Needed where a head namespace legitimately carries a non-parameter entry
(a position_ids range, a cached mask) that no setter consumes.
Sourcepub fn verify(&self, report: &LoadReport) -> Result<()>
pub fn verify(&self, report: &LoadReport) -> Result<()>
Fail when the checkpoint holds an unrecognised tensor inside a namespace this wrapper binds.
Call it after every head tensor has been bound, so that
LoadReport::mark_loaded has already moved the recognised names out of
LoadReport::ignored.
§Errors
Fails when any entry under a claimed namespace was left unconsumed, naming every offender and the namespaces that were claimed.
Trait Implementations§
Source§impl<'a> Clone for BoundNamespaces<'a>
impl<'a> Clone for BoundNamespaces<'a>
impl<'a> Copy for BoundNamespaces<'a>
Auto Trait Implementations§
impl<'a> Freeze for BoundNamespaces<'a>
impl<'a> RefUnwindSafe for BoundNamespaces<'a>
impl<'a> Send for BoundNamespaces<'a>
impl<'a> Sync for BoundNamespaces<'a>
impl<'a> Unpin for BoundNamespaces<'a>
impl<'a> UnsafeUnpin for BoundNamespaces<'a>
impl<'a> UnwindSafe for BoundNamespaces<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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