Class: FunctionCall

Invocation of a function in a pipeline. Can reference a defined Function by name, OR inline a callable directly for external library functions. OR inline a class_call for classes that need instantiation then calling. Use arguments to specify inputs by name (referencing previous outputs or values).

URI: tvbo:class/FunctionCall

 classDiagram
    class FunctionCall
    click FunctionCall href "./FunctionCall.html"
      FunctionCall : aggregate
        
          
    
        
        
        FunctionCall --> "0..1" Aggregation : aggregate
        click Aggregation href "./Aggregation.html"
    

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

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

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

        
      FunctionCall : class_call
        
          
    
        
        
        FunctionCall --> "0..1" ClassReference : class_call
        click ClassReference href "./ClassReference.html"
    

        
      FunctionCall : function
        
          
    
        
        
        FunctionCall --> "0..1" Function : function
        click Function href "./Function.html"
    

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

        
      

Slots

Name	Cardinality and Range	Description	Inheritance
function	0..1 Function	Reference to a defined Function (by name)	direct
callable	0..1 Callable	Direct callable specification (alternative to function reference)	direct
class_call	0..1 ClassReference	Class instantiation and call (alternative to callable/function)	direct
output	0..1 xsd:string	Name for this step’s output (referenced by subsequent functions)	direct
apply_on_dimension	0..1 DimensionType	Dimension to apply function over (generates vmap in code)	direct
aggregate	0..1 Aggregation	How to aggregate the result across dimensions	direct
arguments	* Argument		direct

Usages

used by	used in	type	used
Observation	pipeline	range	FunctionCall
DerivedObservation	pipeline	range	FunctionCall
Optimization	loss	range	FunctionCall
Exploration	observable	range	FunctionCall
Algorithm	functions	range	FunctionCall

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: FunctionCall
description: Invocation of a function in a pipeline. Can reference a defined Function
  by name, OR inline a callable directly for external library functions. OR inline
  a class_call for classes that need instantiation then calling. Use arguments to
  specify inputs by name (referencing previous outputs or values).
from_schema: https://w3id.org/tvbo
attributes:
  function:
    name: function
    description: Reference to a defined Function (by name)
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - FunctionCall
    - Noise
    range: Function
    inlined: false
  callable:
    name: callable
    description: Direct callable specification (alternative to function reference)
    from_schema: https://w3id.org/tvbo
    domain_of:
    - Function
    - FunctionCall
    range: Callable
    inlined: true
  class_call:
    name: class_call
    description: 'Class instantiation and call (alternative to callable/function).
      Use for external library classes that need __init__ then __call__. Example:
      Bold monitor from tvboptim.'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - FunctionCall
    range: ClassReference
    inlined: true
  output:
    name: output
    description: Name for this step's output (referenced by subsequent functions)
    from_schema: https://w3id.org/tvbo
    domain_of:
    - Dynamics
    - Function
    - FunctionCall
    range: string
  apply_on_dimension:
    name: apply_on_dimension
    description: Dimension to apply function over (generates vmap in code). E.g.,
      'node' applies per-node.
    from_schema: https://w3id.org/tvbo
    domain_of:
    - Function
    - FunctionCall
    range: DimensionType
  aggregate:
    name: aggregate
    description: 'How to aggregate the result across dimensions. Example: aggregate.over=node,
      aggregate.type=mean applies function per node, then averages. Used in loss functions.'
    from_schema: https://w3id.org/tvbo
    domain_of:
    - Function
    - LossFunction
    - FunctionCall
    range: Aggregation
    inlined: true
  arguments:
    name: arguments
    from_schema: https://w3id.org/tvbo
    domain_of:
    - Function
    - FunctionCall
    - AlgorithmInclude
    range: Argument
    multivalued: true
    inlined: true
    inlined_as_list: true

Induced

name: FunctionCall
description: Invocation of a function in a pipeline. Can reference a defined Function
  by name, OR inline a callable directly for external library functions. OR inline
  a class_call for classes that need instantiation then calling. Use arguments to
  specify inputs by name (referencing previous outputs or values).
from_schema: https://w3id.org/tvbo
attributes:
  function:
    name: function
    description: Reference to a defined Function (by name)
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: function
    owner: FunctionCall
    domain_of:
    - FunctionCall
    - Noise
    range: Function
    inlined: false
  callable:
    name: callable
    description: Direct callable specification (alternative to function reference)
    from_schema: https://w3id.org/tvbo
    alias: callable
    owner: FunctionCall
    domain_of:
    - Function
    - FunctionCall
    range: Callable
    inlined: true
  class_call:
    name: class_call
    description: 'Class instantiation and call (alternative to callable/function).
      Use for external library classes that need __init__ then __call__. Example:
      Bold monitor from tvboptim.'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: class_call
    owner: FunctionCall
    domain_of:
    - FunctionCall
    range: ClassReference
    inlined: true
  output:
    name: output
    description: Name for this step's output (referenced by subsequent functions)
    from_schema: https://w3id.org/tvbo
    alias: output
    owner: FunctionCall
    domain_of:
    - Dynamics
    - Function
    - FunctionCall
    range: string
  apply_on_dimension:
    name: apply_on_dimension
    description: Dimension to apply function over (generates vmap in code). E.g.,
      'node' applies per-node.
    from_schema: https://w3id.org/tvbo
    alias: apply_on_dimension
    owner: FunctionCall
    domain_of:
    - Function
    - FunctionCall
    range: DimensionType
  aggregate:
    name: aggregate
    description: 'How to aggregate the result across dimensions. Example: aggregate.over=node,
      aggregate.type=mean applies function per node, then averages. Used in loss functions.'
    from_schema: https://w3id.org/tvbo
    alias: aggregate
    owner: FunctionCall
    domain_of:
    - Function
    - LossFunction
    - FunctionCall
    range: Aggregation
    inlined: true
  arguments:
    name: arguments
    from_schema: https://w3id.org/tvbo
    alias: arguments
    owner: FunctionCall
    domain_of:
    - Function
    - FunctionCall
    - AlgorithmInclude
    range: Argument
    multivalued: true
    inlined: true
    inlined_as_list: true