Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
hyperiax 3.0
hyperiax 3.0

Tutorials

  • Tutorials
    • Quickstart — Hyperiax in five minutes
    • Writing your own sweeps
    • Phylogenetic mean on a real tree
    • Bayesian phylogenetic inference with discrete BFFG
    • Gaussian MCMC — BFFG with a hand-rolled kernel
    • Gaussian NUTS — and what its existence proves
    • Shape inference — Kunita flows with non-linear transitions

API reference

  • API reference
    • hyperiax.Topology
    • hyperiax.Tree
    • hyperiax.Schema
    • hyperiax.FieldSpec
    • hyperiax.SweepFn
    • hyperiax.Node
    • hyperiax.Children
    • hyperiax.ChildrenAxis
    • hyperiax.up
    • hyperiax.down
    • hyperiax.symmetric_topology
    • hyperiax.from_parents
    • hyperiax.from_newick
    • hyperiax.to_newick
    • hyperiax.HyperiaxError
    • hyperiax.MissingField
    • hyperiax.SchemaMismatch
    • hyperiax.prebuilt.phylo_mean
    • hyperiax.prebuilt.bffg.discrete_schema
    • hyperiax.prebuilt.bffg.init_discrete_tree
    • hyperiax.prebuilt.bffg.discrete_bf_sweep
    • hyperiax.prebuilt.bffg.discrete_forward_sweep
    • hyperiax.prebuilt.bffg.discrete_fg_sweep
    • hyperiax.prebuilt.bffg.discrete_refine_anchor
    • hyperiax.prebuilt.bffg.continuous_schema
    • hyperiax.prebuilt.bffg.init_continuous_tree
    • hyperiax.prebuilt.bffg.continuous_bf_sweep
    • hyperiax.prebuilt.bffg.continuous_forward_sweep
    • hyperiax.prebuilt.bffg.continuous_fg_sweep
    • hyperiax.prebuilt.bffg.continuous_refine_anchor
    • hyperiax.prebuilt.bffg.propagate_linearization
Back to top
View this page
Edit this page

hyperiax.FieldSpec¶

class hyperiax.FieldSpec(shape, dtype=None)[source]¶

Bases: object

Per-node trailing shape and dtype of a single Tree field.

Parameters:
  • shape (tuple[int, ...])

  • dtype (object | None)

__init__(shape, dtype=None)¶
Parameters:
  • shape (tuple[int, ...])

  • dtype (object | None)

Return type:

None

Methods

__init__(shape[, dtype])

Attributes

dtype

shape

shape: tuple[int, ...]¶
dtype: object | None = None¶
Next
hyperiax.SweepFn
Previous
hyperiax.Schema
Copyright © 2026, hyperiax authors
Made with Sphinx and @pradyunsg's Furo
On this page
  • hyperiax.FieldSpec
    • FieldSpec
      • FieldSpec.__init__()
      • FieldSpec.shape
      • FieldSpec.dtype