Class: FreeParameter

One degree of freedom in an OptimizationStage. References an existing Parameter by dotted scope (e.g. “ReducedWongWang.w” or “FastLinearCoupling.G”) and supplies optimization-specific metadata (heterogeneous, shape, bounds, initial value). No new Parameter is created here.

URI: tvbo:FreeParameter

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

        
      FreeParameter : domain
        
          
    
        
        
        FreeParameter --> "0..1" Range : domain
        click Range href "./Range.html"
    

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

        
      FreeParameter : initial_value
        
          
    
        
        
        FreeParameter --> "0..1" ScalarValue : initial_value
        click ScalarValue href "./ScalarValue.html"
    

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

        
      FreeParameter : parameter
        
          
    
        
        
        FreeParameter --> "1" Parameter : parameter
        click Parameter href "./Parameter.html"
    

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

        
      

Class Properties

Property	Value
Class URI	tvbo:FreeParameter

Slots

Name	Cardinality and Range	Description	Inheritance
label	0..1 xsd:string		direct
description	0..1 xsd:string		direct
parameter	1 Parameter	Dotted reference to the Parameter to optimize	direct
heterogeneous	0..1 xsd:boolean	If true, the parameter is optimized per-element (broadcast to shape)	direct
shape	0..1 xsd:string	Optimization shape as a Python-tuple-style string (e	direct
initial_value	0..1 ScalarValue	Optional initial value for the optimizer (overrides the referenced Parameter’…	direct
domain	0..1 Range	Optional bounds (lo, hi) for constrained optimization	direct

Usages

used by	used in	type	used
OptimizationStage	free_parameters	range	FreeParameter
Optimization	free_parameters	range	FreeParameter

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: FreeParameter
description: One degree of freedom in an OptimizationStage. References an existing
  Parameter by dotted scope (e.g. "ReducedWongWang.w" or "FastLinearCoupling.G") and
  supplies optimization-specific metadata (heterogeneous, shape, bounds, initial value).
  No new Parameter is created here.
from_schema: https://w3id.org/tvbo
slots:
- label
- description
attributes:
  parameter:
    name: parameter
    description: 'Dotted reference to the Parameter to optimize. Format: "<scope>.<param_name>"
      where <scope> is either a Dynamics class name or a coupling key.'
    from_schema: https://w3id.org/tvbo
    domain_of:
    - ExplorationAxis
    - FreeParameter
    range: Parameter
    required: true
    inlined: false
  heterogeneous:
    name: heterogeneous
    description: If true, the parameter is optimized per-element (broadcast to `shape`).
      If false, a single scalar is optimized and broadcast at runtime.
    from_schema: https://w3id.org/tvbo
    ifabsent: boolean(false)
    domain_of:
    - Parameter
    - FreeParameter
    range: boolean
  shape:
    name: shape
    description: Optimization shape as a Python-tuple-style string (e.g. "(n_nodes,)"
      or "(n_nodes, n_nodes)"). Required when heterogeneous is true.
    from_schema: https://w3id.org/tvbo
    domain_of:
    - Matrix
    - NamedArray
    - Parameter
    - FreeParameter
    - NDArray
    range: string
  initial_value:
    name: initial_value
    description: Optional initial value for the optimizer (overrides the referenced
      Parameter's value).
    from_schema: https://w3id.org/tvbo
    domain_of:
    - StateVariable
    - FreeParameter
    - SpatialField
    range: ScalarValue
  domain:
    name: domain
    description: Optional bounds (lo, hi) for constrained optimization.
    from_schema: https://w3id.org/tvbo
    domain_of:
    - ClinicalScale
    - ClinicalScore
    - StateVariable
    - Distribution
    - Parameter
    - ExplorationAxis
    - FreeParameter
    - PDE
    range: Range
    inlined: true
class_uri: tvbo:FreeParameter

Induced

name: FreeParameter
description: One degree of freedom in an OptimizationStage. References an existing
  Parameter by dotted scope (e.g. "ReducedWongWang.w" or "FastLinearCoupling.G") and
  supplies optimization-specific metadata (heterogeneous, shape, bounds, initial value).
  No new Parameter is created here.
from_schema: https://w3id.org/tvbo
attributes:
  parameter:
    name: parameter
    description: 'Dotted reference to the Parameter to optimize. Format: "<scope>.<param_name>"
      where <scope> is either a Dynamics class name or a coupling key.'
    from_schema: https://w3id.org/tvbo
    owner: FreeParameter
    domain_of:
    - ExplorationAxis
    - FreeParameter
    range: Parameter
    required: true
    inlined: false
  heterogeneous:
    name: heterogeneous
    description: If true, the parameter is optimized per-element (broadcast to `shape`).
      If false, a single scalar is optimized and broadcast at runtime.
    from_schema: https://w3id.org/tvbo
    ifabsent: boolean(false)
    owner: FreeParameter
    domain_of:
    - Parameter
    - FreeParameter
    range: boolean
  shape:
    name: shape
    description: Optimization shape as a Python-tuple-style string (e.g. "(n_nodes,)"
      or "(n_nodes, n_nodes)"). Required when heterogeneous is true.
    from_schema: https://w3id.org/tvbo
    owner: FreeParameter
    domain_of:
    - Matrix
    - NamedArray
    - Parameter
    - FreeParameter
    - NDArray
    range: string
  initial_value:
    name: initial_value
    description: Optional initial value for the optimizer (overrides the referenced
      Parameter's value).
    from_schema: https://w3id.org/tvbo
    owner: FreeParameter
    domain_of:
    - StateVariable
    - FreeParameter
    - SpatialField
    range: ScalarValue
  domain:
    name: domain
    description: Optional bounds (lo, hi) for constrained optimization.
    from_schema: https://w3id.org/tvbo
    owner: FreeParameter
    domain_of:
    - ClinicalScale
    - ClinicalScore
    - StateVariable
    - Distribution
    - Parameter
    - ExplorationAxis
    - FreeParameter
    - PDE
    range: Range
    inlined: true
  label:
    name: label
    from_schema: https://w3id.org/tvbo
    rank: 1000
    slot_uri: rdfs:label
    owner: FreeParameter
    domain_of:
    - ParcellationTerminology
    - Subject
    - Session
    - Dataset
    - Contact
    - SoftwareEnvironment
    - Equation
    - Stimulus
    - Event
    - Parcellation
    - Tractogram
    - Matrix
    - Phenotype
    - Network
    - Node
    - Edge
    - Observation
    - Dynamics
    - StateVariable
    - Parameter
    - Function
    - FunctionCall
    - DerivedVariable
    - RandomStream
    - DataSource
    - OptimizationStage
    - Exploration
    - ExplorationAxis
    - FreeParameter
    - Inference
    - AlgorithmStage
    - TuningObjective
    - Continuation
    - Coupling
    - RegionMapping
    - SimulationExperiment
    - SimulationStudy
    - TimeSeries
    - NDArray
    - SpatialDomain
    - Mesh
    - SpatialField
    - FieldStateVariable
    - DifferentialOperator
    - BoundaryCondition
    - PDESolver
    - PDE
    range: string
  description:
    name: description
    from_schema: https://w3id.org/tvbo
    rank: 1000
    slot_uri: dcterms:description
    owner: FreeParameter
    domain_of:
    - Dataset
    - ClinicalScore
    - SoftwarePackage
    - SoftwareRequirement
    - SoftwareEnvironment
    - Equation
    - Stimulus
    - Event
    - Tractogram
    - Matrix
    - Phenotype
    - MeasureSpec
    - NamedArray
    - Network
    - GraphGenerator
    - ProcedureStep
    - File
    - Node
    - Edge
    - Observation
    - Dynamics
    - StateVariable
    - Parameter
    - CouplingInput
    - Argument
    - Function
    - FunctionCall
    - Callable
    - DerivedParameter
    - DerivedVariable
    - RandomStream
    - DataSource
    - OptimizationStage
    - Exploration
    - ExplorationAxis
    - FreeParameter
    - Inference
    - Prior
    - Likelihood
    - UpdateRule
    - AlgorithmStage
    - TuningObjective
    - Algorithm
    - BranchSwitch
    - Continuation
    - Integrator
    - Coupling
    - RegionMapping
    - SimulationExperiment
    - Study
    - TimeSeries
    - NDArray
    - SpatialDomain
    - Mesh
    - SpatialField
    - FieldStateVariable
    - BoundaryCondition
    - PDESolver
    - PDE
    range: string
class_uri: tvbo:FreeParameter