API · CoreStablesince v0.9.2

Core — API

The three primitives you compose every NeuronScope program from — Scope, Recorder, and Probe — plus the Session that groups them.

Audience: ProgrammersRead: 5 minSource

Every runnable NeuronScope program touches exactly these symbols. They live in the top-level namespace so imports stay short.

Symbols

KindSymbolStatusSummary
classneuronscope.ScopeStableThe context manager that binds a model, a probe, and an output artifact for a single recording.
classneuronscope.RecorderStableThe framework-agnostic recorder invoked by Scope. Installs hooks, streams observations, seals the artifact.
classneuronscope.ProbeStableBase class for observations. Declares which layers to touch and how to summarise the tensor.
classneuronscope.SessionStableGroups related experiments into a single directory with a shared plan.
functionneuronscope.recordStableOne-line shorthand for Scope. Prefer this in application code.
functionneuronscope.seed_allStableSets seeds in every framework the recorder can see. Required for deterministic runs.
constantneuronscope.__version__StableThe installed library version as a string. Currently 0.9.2.

How they compose

A Scope is a thin composition of one Recorder and one or more Probe instances. The Session exists to keep several related recordings in one place — it is a convenience, not a semantic layer.

Related