User Guide#

This user guide provides detailed information about how to use Param, assuming you have worked through the Getting Started guide.

  • Simplifying Codebases: How Param allows you to eliminate boilerplate and unsafe code

  • Parameters: Using parameters (Class vs. instance parameters, setting defaults, etc.)

  • Parameter Types: Predefined Parameter classes available for your use

  • Dependencies and Watchers: Expressing relationships between parameters and parameters or code, and triggering events.

  • References: Allowing parameters to resolve references to other parameters, reactive expressions, functions and generators.

  • Reactive Expressions: How to write expressions and functions that automatically re-evaluate when their parameter inputs change.

  • Generators: Using (asynchronous) generators to drive events on parameters and expressions in a “push” based model.

  • Serialization and Persistence: Saving the state of a Parameterized object to a text, script, or pickle file

  • Outputs: Output types and connecting output to Parameter inputs

  • Logging and Warnings: Logging, messaging, warning, and raising errors on Parameterized objects

  • ParameterizedFunctions: Parameterized function objects, for configurable callables

  • Dynamic Parameters: Using dynamic parameter values with and without Numbergen

  • How Param Works: Internal details, for Param developers and power users

  • Using Param in GUIs: (external site) Using Param with Panel to make GUIs