burn_p2p_auth_github 0.21.0-pre.3

Optional GitHub auth connector for burn_p2p.
Documentation

burn_p2p 🔥🤝

burn_p2p is the public entrypoint for peer-to-peer Burn training.

start with P2pProjectFamily, P2pWorkload, and NodeBuilder.

install

[dependencies]
burn_p2p = "=0.21.0-pre.3"

for the Burn-backed runtime path and examples:

[dependencies]
burn_p2p = { version = "=0.21.0-pre.3", features = ["burn"] }

usage

the model is family/workload first:

use burn_p2p::{
    GenesisSpec, NodeBuilder, SingleWorkloadProjectFamily, StorageConfig,
};

let family = SingleWorkloadProjectFamily::new(release_manifest, workload)?;

let node = NodeBuilder::new(family)
    .with_mainnet(GenesisSpec {
        network_id,
        protocol_version,
        display_name,
        created_at,
        metadata,
    })
    .with_storage(StorageConfig::new("./burn-p2p-node"))
    .spawn()?;

full example: crates/burn_p2p/examples/family_workload_minimal.rs.

examples

# minimal family/workload integration
cargo run -p burn_p2p --example family_workload_minimal

# synthetic runtime walkthrough
cargo run -p burn_p2p --example synthetic_trainer

# burn-backed facade example
cargo run -p burn_p2p --example burn_ndarray_runtime --features burn

other crates

there are also companion crates for:

  • bootstrap and operator surfaces
  • browser workers and edge clients
  • artifact publication and download
  • metrics indexing and portal rendering
  • auth and social integrations

start from burn_p2p. reach for the others only when you are building deployment, browser, or operator flows.

docs