sax package

Subpackages

• sax.backends package
  • Submodules
    • sax.backends.additive module
      • analyze_instances_additive()
      • analyze_circuit_additive()
      • evaluate_circuit_additive()
    • sax.backends.filipsson_gunnar module
      • analyze_instances_fg()
      • analyze_circuit_fg()
      • evaluate_circuit_fg()
    • sax.backends.klu module
      • analyze_instances_klu()
      • analyze_circuit_klu()
      • evaluate_circuit_klu()
  • Module contents
    • analyze_instances()
    • analyze_circuit()
    • evaluate_circuit()

Submodules

• sax.circuit module
  • CircuitInfo
    • CircuitInfo.dag
    • CircuitInfo.models
  • circuit()
  • draw_dag()
  • get_required_circuit_models()
• sax.loss module
  • mse()
  • huber_loss()
  • l2_reg()
• sax.models module
  • straight()
  • coupler()
  • unitary()
  • copier()
  • passthru()
  • get_models()
• sax.multimode module
  • multimode()
  • singlemode()
• sax.netlist module
  • NetlistDict
    • NetlistDict.instances
    • NetlistDict.connections
    • NetlistDict.ports
    • NetlistDict.settings
  • BaseModel
  • Component
    • Component.component
    • Component.settings
  • Placement
    • Placement.x
    • Placement.y
    • Placement.dx
    • Placement.dy
    • Placement.rotation
    • Placement.mirror
    • Placement.xmin
    • Placement.xmax
    • Placement.ymin
    • Placement.ymax
    • Placement.port
  • Netlist
    • Netlist.instances
    • Netlist.connections
    • Netlist.ports
    • Netlist.placements
    • Netlist.settings
  • RecursiveNetlist
    • RecursiveNetlist.root
  • netlist()
  • flatten_netlist()
  • load_netlist()
  • load_recursive_netlist()
  • is_recursive()
  • is_not_recursive()
  • get_netlist_instances_by_prefix()
  • get_component_instances()
• sax.saxtypes module
  • IntArray1D
  • FloatArray1D
  • ComplexArray1D
  • IntArrayND
  • FloatArrayND
  • ComplexArrayND
  • PortMap
  • PortCombination
  • SDict
  • SDense
  • SCoo
  • Settings
  • SType
  • Model
  • ModelFactory
  • is_float()
  • is_complex()
  • is_complex_float()
  • is_sdict()
  • is_scoo()
  • is_sdense()
  • is_model()
  • is_model_factory()
  • validate_model()
  • is_stype()
  • is_singlemode()
  • is_multimode()
  • is_mixedmode()
  • sdict()
  • scoo()
  • sdense()
  • modelfactory()
• sax.utils module
  • block_diag()
  • clean_string()
  • copy_settings()
  • validate_settings()
  • try_complex_float()
  • flatten_dict()
  • unflatten_dict()
  • get_ports()
  • get_port_combinations()
  • get_settings()
  • grouped_interp()
  • merge_dicts()
  • mode_combinations()
  • reciprocal()
  • rename_params()
  • rename_ports()
  • update_settings()
  • validate_not_mixedmode()
  • validate_multimode()
  • validate_sdict()
  • get_inputs_outputs()
  • hash_dict()
  • Normalization
    • Normalization.mean
    • Normalization.std
  • normalization()
  • cartesian_product()
  • normalize()
  • denormalize()

Module contents

SAX: S + Autograd + XLA