Skip to main content

ArtifactLoader

Struct ArtifactLoader 

Source
pub struct ArtifactLoader<T: BundleDecode> { /* private fields */ }
Expand description

Artifact loader for loading artifacts from Burn Central. It allow to fecth for instance other experiment endpoint to be able to restart from a certain point your experiment.

You can build it yourself by using the ArtifactLoader::new function with your namespace (in slug format (e.g. “my-team”)), project name and a burn_central_core::BurnCentral. However, it is also possible to request it directly in your routine by using declaring the param like so:

#[derive(Deserialize, Serialize, Default)]
pub struct LaunchArgs {
    pub experiment_num: Option<i32>,
}

#[register(training, name = "mnist")]
pub fn training<B: AutodiffBackend>(
    config: Args<LaunchArgs>,
    MultiDevice(devices): MultiDevice<B>,
    loader: ArtifactLoader<ModelArtifact<B>>,
) -> Result<Model<ModelArtifact<B::InnerBackend>>, String> {
    // Load a pretrained model if an experiment number is provided.
    if let Some(experiment_num) = config.experiment_num {
        let pretrained_model = loader
            .load(experiment_num, "train_artifacts")
            .expect("To be able to fetch artifacts");
    }
}

As you can see in the example above, you can use the loader to dynamically request experiment artifacts when requested through your routine configuration.

Implementations§

Source§

impl<T: BundleDecode> ArtifactLoader<T>

Source

pub fn new(namespace: String, project_name: String, client: BurnCentral) -> Self

Source

pub fn load_with( &self, experiment_num: i32, name: impl AsRef<str>, settings: &T::Settings, ) -> Result<T, ArtifactError>

Load an artifact by name with specific settings.

Source

pub fn load( &self, experiment_num: i32, name: impl AsRef<str>, ) -> Result<T, ArtifactError>

Load an artifact by name with default settings.

Auto Trait Implementations§

§

impl<T> Freeze for ArtifactLoader<T>

§

impl<T> !RefUnwindSafe for ArtifactLoader<T>

§

impl<T> Send for ArtifactLoader<T>
where T: Send,

§

impl<T> Sync for ArtifactLoader<T>
where T: Sync,

§

impl<T> Unpin for ArtifactLoader<T>
where T: Unpin,

§

impl<T> !UnwindSafe for ArtifactLoader<T>

Blanket Implementations§

Source§

impl<T> Adaptor<()> for T

Source§

fn adapt(&self)

Adapt the type to be passed to a metric.
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> 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> 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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: 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
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.
Source§

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

Source§

fn vzip(self) -> V

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