burn/burn-import/README.md

Burn Import: A Crate for ONNX Model Import into the Burn Framework

burn-import facilitates the seamless import of machine learning models, particularly those in the ONNX format, into the Burn deep learning framework. It automatically generates Rust source code, aligns the model structure with Burn's native format, and converts tensor data for Burn compatibility.

Note: This crate is in active development and currently supports a limited set of ONNX operators.

Working Examples

For practical examples, please refer to:

1. ONNX Inference Example
2. SqueezeNet Image Classification

Usage

Importing ONNX Models

Follow these steps to import an ONNX model into your Burn project:

1. Update build.rs: Include the following Rust code in your build.rs file:

   use burn_import::onnx::ModelGen;
   
   fn main() {
       // Generate Rust code from the ONNX model file
       ModelGen::new()
           .input("src/model/mnist.onnx")
           .out_dir("model/")
           .run_from_script();
   }
   

2. Modify mod.rs: Add this code to the mod.rs file located in src/model:

   pub mod mnist {
       include!(concat!(env!("OUT_DIR"), "/model/mnist.rs"));
   }
   

3. Utilize Imported Model: Use the following sample code to incorporate the imported model into your application:

   mod model;
   
   use burn::tensor;
   use burn_ndarray::NdArrayBackend;
   use model::mnist::Model;
   
   fn main() {
       // Initialize a new model instance
       let model: Model<NdArrayBackend<f32>> = Model::new();
   
       // Create a sample input tensor (zeros for demonstration)
       let input = tensor::Tensor::<NdArrayBackend<f32>, 4>::zeros([1, 1, 28, 28]);
   
       // Execute the model
       let output = model.forward(input);
   
       // Display the output
       println!("{:?}", output);
   }
   

Contribution

Interested in contributing to burn-import? Check out our development guide for more information.