Submitting Examples to Burn

This guide explains how to create and submit new examples to the Burn repository. Examples are a great way to demonstrate Burn's capabilities and help users understand how to use the framework effectively.

For a minimal working example, see the simple-regression example in the repository.

Repository Structure

The Burn repository is set up as a workspace, with examples located in the examples/ directory. Each example is a separate crate that can reuse workspace dependencies.

Creating a New Example

1. Navigate to the examples directory:

   bashCopy

   cd examples
   

2. Create a new library crate:

   bashCopy

   cargo new --lib <my-example>
   

3. Update the example's Cargo.toml:

   tomlCopy

   [package]
   name = "<my-example>"
   version = "0.1.0"
   edition = "2021"
   readme = "README.md"
   # Remove this line if it exists
   # readme.workspace = true
   
   [dependencies]
   # Reuse workspace dependencies when available
   serde = { workspace = true }
   # Add example-specific dependencies
   burn = { path = "../../" }
   

Required Files and Structure

README.md

Each example must include a README.md file with:

• A brief description of what the example demonstrates
• A terminal command showing how to run the example
• Any prerequisites or setup instructions

Example README structure:

# Example Name

Brief description of what this example demonstrates.

## Running the Example

```bash
cargo run --example <my-example>
```

## Prerequisites

List any prerequisites here.

Source Code Structure

• src/ directory: Contains the main implementation code
• examples/ directory: Contains example code
  • <my-example>.rs: Example implementation

Resource Handling

• Resources (datasets, models, etc.) should be downloaded in the example code
• Do not track external files in the repository
• Include code to download and prepare resources when the example is run

Best Practices

1. Code Organization

   • Keep the code modular and well-documented
   • Use clear, descriptive variable and function names
   • Include comments explaining complex operations

2. Error Handling

   • Implement proper error handling
   • Provide meaningful error messages
   • Handle resource download failures gracefully

3. Performance

   • Optimize for reasonable execution time
   • Include progress indicators for long-running operations
   • Consider adding configuration options for different hardware capabilities

4. Documentation

   • Document all public APIs
   • Include inline comments for complex logic
   • Explain any non-obvious implementation details

Submitting Your Example

1. Ensure your example follows all the guidelines above
2. Test your example thoroughly
3. Create a pull request with:
   • A clear description of what the example demonstrates
   • Any relevant issue numbers
   • Screenshots or output examples (if applicable)

Feel free to ask questions in the pull request if you need clarification or guidance.