Skip to content

Docs: improve explanation of parameter printing #364

@mjyb16

Description

@mjyb16

Currently the docs state this in the FAQ:
Q: How do I know what order to put the parameter values in the pytorch tensor which gets passed to the simulator?
A: If you are using any Module object (so a simulator), then you can get the parameters using print(simulator). The order of the dynamical parameters (top to bottom) corresponds to the order you should use in your parameter value tensor. Note that you can ignore the static parameters.

A better way is to just print(simulator.dynamic_params), which eliminates much of the visual clutter when you have potentially dozens of static parameters to sort through. It is also worth mentioning the new Caustics automated tensor functionality (which I admit I haven't tried yet but will in the next week or so). I will create a PR soon to address this (unless someone beats me to it).

Metadata

Metadata

Assignees

Labels

docsImprovements or additions to documentation

Type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions