Skip to main content

BurnGraph

Struct BurnGraph 

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

Burn graph intermediate representation of modules and tensor operations.

Implementations§

Source§

impl BurnGraph

Source

pub fn register(&mut self, node: Node)

Register a new operation node into the graph.

§Notes

The node must be registered in the same order they will be executed in the forward pass.

Source

pub fn with_burnpack( self, out_file: PathBuf, strategy: LoadStrategy, ) -> BurnGraph

Save the state of each node in a burnpack file and generate weight-loading constructors.

The LoadStrategy controls which constructors are generated on the Model struct.

Source

pub fn with_blank_space(self, blank_spaces: bool) -> BurnGraph

Add blank spaces in some places

§Notes

It can be problematic when testing.

Source

pub fn with_top_comment(self, top_comment: Option<String>) -> BurnGraph

Add a comment at the top of the generated file.

Source

pub fn with_partition(self, partition: bool) -> BurnGraph

Enable or disable submodule partitioning for large models.

Source

pub fn codegen(self) -> TokenStream

Generate tokens representing the graph with Burn modules and tensor operations.

Source

pub fn register_input_output( &mut self, input_names: Vec<String>, output_names: Vec<String>, input_args: &[Argument], output_args: &[Argument], )

Register the input and output types of the graph using the passed in names. The names must be unique and match the names of the inputs and outputs of the nodes. The order will be preserved.

§Arguments
  • input_names - The names of the inputs of the graph.
  • output_names - The names of the outputs of the graph.
  • input_args - The input arguments (from ONNX graph, used for empty graphs).
  • output_args - The output arguments (from ONNX graph, used for empty graphs).

Trait Implementations§

Source§

impl Debug for BurnGraph

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BurnGraph

Source§

fn default() -> BurnGraph

Returns the “default value” for a type. 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> 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, 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