NeuronScope
SDKStablesince v0.1.0

Python SDK

The reference implementation. Ships the recorder, comparison engine, and framework adapters. All other SDKs read the same .nsz format.

Audience: All usersRead: 5 minSource

Install

shellbash
pip install neuronscope

Optional extras: [torch], [jax], [hf] pull the corresponding framework adapters. The base wheel has no framework dependencies.

Public surface

Only names re-exported from the top-level neuronscope package are part of the public API. Everything under neuronscope._internal is subject to change.

surface.py·
·python
import neuronscope as ns

ns.Recorder     # class — see /api/core/recorder
ns.Scope        # class — see /api/core/scope
ns.fingerprint  # function
ns.load         # function
ns.compare      # function
ns.probes       # submodule

Stability

  • SemVer applies to the public surface only.
  • Artifact format (.nsz) has an independent version — see the serialization flow.
  • Deprecations run for one minor version with a runtime warning before removal.
Related