Class: UpdateRule

Defines how a parameter is updated based on observables. Represents iterative learning rules like FIC or EIB updates. Functions from experiment.functions are available in the equation.

URI: tvbo:class/UpdateRule

 classDiagram
    class UpdateRule
    click UpdateRule href "./UpdateRule.html"
      UpdateRule : bounds
        
          
    
        
        
        UpdateRule --> "0..1" Range : bounds
        click Range href "./Range.html"
    

        
      UpdateRule : description
        
          
    
        
        
        UpdateRule --> "0..1" String : description
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

        
      UpdateRule : equation
        
          
    
        
        
        UpdateRule --> "1" Equation : equation
        click Equation href "./Equation.html"
    

        
      UpdateRule : name
        
          
    
        
        
        UpdateRule --> "1" String : name
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

        
      UpdateRule : requires
        
          
    
        
        
        UpdateRule --> "*" Observation : requires
        click Observation href "./Observation.html"
    

        
      UpdateRule : target_parameter
        
          
    
        
        
        UpdateRule --> "1" Parameter : target_parameter
        click Parameter href "./Parameter.html"
    

        
      UpdateRule : warmup
        
          
    
        
        
        UpdateRule --> "0..1" Boolean : warmup
        click Boolean href "../http://www.w3.org/2001/XMLSchema#boolean.html"
    

        
      

Slots

Name	Cardinality and Range	Description	Inheritance
name	1 xsd:string		direct
description	0..1 xsd:string		direct
target_parameter	1 Parameter	The parameter to update (e	direct
equation	1 Equation	Update equation (e	direct
bounds	0..1 Range	Constraints on parameter values after update	direct
warmup	0..1 xsd:boolean	Whether to apply learning rate warmup to this update rule	direct
requires	* Observation	Observables required by this update rule	direct

Usages

used by	used in	type	used
Algorithm	update_rules	range	UpdateRule

Identifier and Mapping Information

Schema Source

• from schema: https://w3id.org/tvbo

Mappings

Mapping Type	Mapped Value
self	tvbo:UpdateRule
native	tvbo:UpdateRule

LinkML Source

Direct

name: UpdateRule
description: Defines how a parameter is updated based on observables. Represents iterative
  learning rules like FIC or EIB updates. Functions from experiment.functions are
  available in the equation.
from_schema: https://w3id.org/tvbo
slots:
- name
- description
attributes:
  target_parameter:
    name: target_parameter
    description: The parameter to update (e.g., J_i, wLRE)
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - UpdateRule
    range: Parameter
    required: true
    inlined: true
  equation:
    name: equation
    description: Update equation (e.g., 'J_i + eta * delta'). Can use functions defined
      in experiment.functions section.
    from_schema: https://w3id.org/tvbo
    domain_of:
    - Stimulus
    - Observation
    - StateVariable
    - Distribution
    - Parameter
    - Function
    - Case
    - DerivedParameter
    - DerivedVariable
    - Noise
    - UpdateRule
    - DifferentialOperator
    range: Equation
    required: true
    inlined: true
  bounds:
    name: bounds
    description: Constraints on parameter values after update
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - UpdateRule
    range: Range
    inlined: true
  warmup:
    name: warmup
    description: Whether to apply learning rate warmup to this update rule. When true,
      the learning rate (eta) is scaled by (i+1)/n_iterations.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - UpdateRule
    range: boolean
  requires:
    name: requires
    description: Observables required by this update rule
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - UpdateRule
    range: Observation
    multivalued: true

Induced

name: UpdateRule
description: Defines how a parameter is updated based on observables. Represents iterative
  learning rules like FIC or EIB updates. Functions from experiment.functions are
  available in the equation.
from_schema: https://w3id.org/tvbo
attributes:
  target_parameter:
    name: target_parameter
    description: The parameter to update (e.g., J_i, wLRE)
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: target_parameter
    owner: UpdateRule
    domain_of:
    - UpdateRule
    range: Parameter
    required: true
    inlined: true
  equation:
    name: equation
    description: Update equation (e.g., 'J_i + eta * delta'). Can use functions defined
      in experiment.functions section.
    from_schema: https://w3id.org/tvbo
    alias: equation
    owner: UpdateRule
    domain_of:
    - Stimulus
    - Observation
    - StateVariable
    - Distribution
    - Parameter
    - Function
    - Case
    - DerivedParameter
    - DerivedVariable
    - Noise
    - UpdateRule
    - DifferentialOperator
    range: Equation
    required: true
    inlined: true
  bounds:
    name: bounds
    description: Constraints on parameter values after update
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: bounds
    owner: UpdateRule
    domain_of:
    - UpdateRule
    range: Range
    inlined: true
  warmup:
    name: warmup
    description: Whether to apply learning rate warmup to this update rule. When true,
      the learning rate (eta) is scaled by (i+1)/n_iterations.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: warmup
    owner: UpdateRule
    domain_of:
    - UpdateRule
    range: boolean
  requires:
    name: requires
    description: Observables required by this update rule
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: requires
    owner: UpdateRule
    domain_of:
    - UpdateRule
    range: Observation
    multivalued: true
  name:
    name: name
    from_schema: https://w3id.org/tvbo
    rank: 1000
    key: true
    alias: name
    owner: UpdateRule
    domain_of:
    - BrainAtlas
    - CommonCoordinateSpace
    - ParcellationEntity
    - DBSProtocol
    - ClinicalScale
    - ClinicalScore
    - Tractogram
    - File
    - Observation
    - Dynamics
    - StateVariable
    - Distribution
    - Parameter
    - CouplingInput
    - Argument
    - Function
    - Callable
    - DerivedParameter
    - DerivedVariable
    - DataSource
    - OptimizationStage
    - Exploration
    - UpdateRule
    - Algorithm
    - Coupling
    - SoftwareEnvironment
    - SoftwareRequirement
    - SoftwarePackage
    range: string
    required: true
  description:
    name: description
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: description
    owner: UpdateRule
    domain_of:
    - ClinicalScore
    - Equation
    - Stimulus
    - Tractogram
    - Matrix
    - Network
    - File
    - Node
    - Edge
    - Observation
    - Dynamics
    - StateVariable
    - Parameter
    - CouplingInput
    - Argument
    - Function
    - Callable
    - DerivedParameter
    - DerivedVariable
    - RandomStream
    - DataSource
    - OptimizationStage
    - Exploration
    - UpdateRule
    - TuningObjective
    - Algorithm
    - Integrator
    - Coupling
    - RegionMapping
    - SimulationExperiment
    - SimulationStudy
    - TimeSeries
    - SoftwareEnvironment
    - SoftwareRequirement
    - SoftwarePackage
    - NDArray
    - SpatialDomain
    - Mesh
    - SpatialField
    - FieldStateVariable
    - BoundaryCondition
    - PDESolver
    - PDE
    range: string