Class: LossFunction

A loss function for optimization with optional aggregation. Extends Function with aggregation specification for per-element losses.

URI: tvbo:class/LossFunction

 classDiagram
    class LossFunction
    click LossFunction href "./LossFunction.html"
      Function <|-- LossFunction
        click Function href "./Function.html"
      
      LossFunction : acronym
        
          
    
        
        
        LossFunction --> "0..1" String : acronym
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

        
      LossFunction : aggregate
        
          
    
        
        
        LossFunction --> "0..1" Aggregation : aggregate
        click Aggregation href "./Aggregation.html"
    

        
      LossFunction : apply_on_dimension
        
          
    
        
        
        LossFunction --> "0..1" DimensionType : apply_on_dimension
        click DimensionType href "../../enums/DimensionType.html"
    

        
      LossFunction : arguments
        
          
    
        
        
        LossFunction --> "*" Argument : arguments
        click Argument href "./Argument.html"
    

        
      LossFunction : callable
        
          
    
        
        
        LossFunction --> "0..1" Callable : callable
        click Callable href "./Callable.html"
    

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

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

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

        
      LossFunction : input
        
          
    
        
        
        LossFunction --> "0..1" Function : input
        click Function href "./Function.html"
    

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

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

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

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

        
      LossFunction : output_equation
        
          
    
        
        
        LossFunction --> "0..1" Equation : output_equation
        click Equation href "./Equation.html"
    

        
      LossFunction : requirements
        
          
    
        
        
        LossFunction --> "*" SoftwareRequirement : requirements
        click SoftwareRequirement href "./SoftwareRequirement.html"
    

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

        
      LossFunction : time_range
        
          
    
        
        
        LossFunction --> "0..1" Range : time_range
        click Range href "./Range.html"

Inheritance

Slots

Name Cardinality and Range Description Inheritance
aggregate 0..1
Aggregation		 How to aggregate the loss across dimensions direct
name 1
xsd:string		 Function
acronym 0..1
xsd:string		 Function
label 0..1
xsd:string		 Function
equation 0..1
Equation		 Function
definition 0..1
xsd:string		 Function
description 0..1
xsd:string		 Function
requirements *
SoftwareRequirement		 Function
input 0..1
Function		 Simple input reference: name of previous function’s output in pipeline Function
output 0..1
xsd:string		 Name for this function’s output (referenced by subsequent functions) Function
iri 0..1
xsd:string		 Function
arguments *
Argument		 Parameters/arguments for the function Function
output_equation 0..1
Equation		 Output transformation equation (if equation-based) Function
source_code 0..1
xsd:string		 Function
callable 0..1
Callable		 Software implementation reference (if software-based) Function
apply_on_dimension 0..1
DimensionType		 Which dimension to apply the transformation on Function
time_range 0..1
Range		 Time range for generated TimeSeries (for kernel generators) Function

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: LossFunction
description: A loss function for optimization with optional aggregation. Extends Function
  with aggregation specification for per-element losses.
from_schema: https://w3id.org/tvbo
is_a: Function
attributes:
  aggregate:
    name: aggregate
    description: 'How to aggregate the loss across dimensions. Example: aggregate.over=node,
      aggregate.type=mean computes loss per node, then averages.'
    from_schema: https://w3id.org/tvbo
    domain_of:
    - Function
    - LossFunction
    - FunctionCall
    range: Aggregation
    inlined: true

Induced

name: LossFunction
description: A loss function for optimization with optional aggregation. Extends Function
  with aggregation specification for per-element losses.
from_schema: https://w3id.org/tvbo
is_a: Function
attributes:
  aggregate:
    name: aggregate
    description: 'How to aggregate the loss across dimensions. Example: aggregate.over=node,
      aggregate.type=mean computes loss per node, then averages.'
    from_schema: https://w3id.org/tvbo
    alias: aggregate
    owner: LossFunction
    domain_of:
    - Function
    - LossFunction
    - FunctionCall
    range: Aggregation
    inlined: true
  name:
    name: name
    from_schema: https://w3id.org/tvbo
    rank: 1000
    key: true
    alias: name
    owner: LossFunction
    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
  acronym:
    name: acronym
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: acronym
    owner: LossFunction
    domain_of:
    - ClinicalScale
    - ClinicalScore
    - Observation
    - Function
    range: string
  label:
    name: label
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: label
    owner: LossFunction
    domain_of:
    - ParcellationTerminology
    - Dataset
    - Contact
    - Equation
    - Stimulus
    - Parcellation
    - Tractogram
    - Matrix
    - Network
    - Node
    - Edge
    - Observation
    - Dynamics
    - StateVariable
    - Parameter
    - Function
    - DerivedVariable
    - RandomStream
    - DataSource
    - OptimizationStage
    - Exploration
    - TuningObjective
    - Coupling
    - RegionMapping
    - SimulationExperiment
    - SimulationStudy
    - TimeSeries
    - SoftwareEnvironment
    - NDArray
    - SpatialDomain
    - Mesh
    - SpatialField
    - FieldStateVariable
    - DifferentialOperator
    - BoundaryCondition
    - PDESolver
    - PDE
    range: string
  equation:
    name: equation
    from_schema: https://w3id.org/tvbo
    rank: 1000
    slot_uri: tvbo:Equation
    alias: equation
    owner: LossFunction
    domain_of:
    - Stimulus
    - Observation
    - StateVariable
    - Distribution
    - Parameter
    - Function
    - Case
    - DerivedParameter
    - DerivedVariable
    - Noise
    - UpdateRule
    - DifferentialOperator
    range: Equation
    inlined: true
  definition:
    name: definition
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: definition
    owner: LossFunction
    domain_of:
    - Equation
    - StateVariable
    - Parameter
    - Function
    - DifferentialOperator
    range: string
  description:
    name: description
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: description
    owner: LossFunction
    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
  requirements:
    name: requirements
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: requirements
    owner: LossFunction
    domain_of:
    - Function
    - SoftwareEnvironment
    - PDESolver
    range: SoftwareRequirement
    multivalued: true
  input:
    name: input
    description: 'Simple input reference: name of previous function''s output in pipeline.
      For multi-argument functions, use arguments with value references instead.'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: input
    owner: LossFunction
    domain_of:
    - Function
    range: Function
    inlined: false
  output:
    name: output
    description: Name for this function's output (referenced by subsequent functions)
    from_schema: https://w3id.org/tvbo
    alias: output
    owner: LossFunction
    domain_of:
    - Dynamics
    - Function
    - FunctionCall
    range: string
  iri:
    name: iri
    from_schema: https://w3id.org/tvbo
    alias: iri
    owner: LossFunction
    domain_of:
    - Dynamics
    - Function
    range: string
  arguments:
    name: arguments
    description: Parameters/arguments for the function
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: arguments
    owner: LossFunction
    domain_of:
    - Function
    - FunctionCall
    - AlgorithmInclude
    range: Argument
    multivalued: true
    inlined: true
    inlined_as_list: true
  output_equation:
    name: output_equation
    description: Output transformation equation (if equation-based)
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: output_equation
    owner: LossFunction
    domain_of:
    - Function
    range: Equation
    inlined: true
  source_code:
    name: source_code
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: source_code
    owner: LossFunction
    domain_of:
    - Function
    range: string
  callable:
    name: callable
    description: Software implementation reference (if software-based)
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: callable
    owner: LossFunction
    domain_of:
    - Function
    - FunctionCall
    range: Callable
    inlined: true
  apply_on_dimension:
    name: apply_on_dimension
    description: Which dimension to apply the transformation on
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: apply_on_dimension
    owner: LossFunction
    domain_of:
    - Function
    - FunctionCall
    range: DimensionType
  time_range:
    name: time_range
    description: Time range for generated TimeSeries (for kernel generators). Equation
      is evaluated at each time point.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: time_range
    owner: LossFunction
    domain_of:
    - Function
    range: Range
    inlined: true