Class ControlPointBuilder

Class defining the builder of an autotuner

Hierarchy (view full)

AutotunerBuilder
- ControlPointBuilder

Constructors

constructor

new ControlPointBuilder(name, datasetType, knobs, measurementType): ControlPointBuilder
Parameters
- name: string
- datasetType: string
- knobs: Field | Field[]
- measurementType: string
Returns ControlPointBuilder
Overrides AutotunerBuilder.constructor
- Defined in kadabra/Kadabra-JS/src-api/kadabra/adapt/Autotuner.ts:523

Properties

algorithms

algorithms: Algorithm[]

algorithmType

algorithmType: string

applyKnob

applyKnob: undefined | string

autotunerControlPointBuilder

autotunerControlPointBuilder: null | string

concurrent

concurrent: boolean = false

config

config: undefined | Configuration

configId

configId: undefined | string

configuration

configuration: undefined | string

datasetType

datasetType: string

distanceMethod

distanceMethod: null | string

knobs

knobs: Field | Field[]

knobType

knobType: string

measurementType

measurementType: string

measurer

measurer: undefined | Measurer

name

name: string

package

package: undefined | string

Methods

addAdaptiveAlg

addAdaptiveAlg(id, targetMethod, templateName, provider): ControlPointBuilder
Parameters
- id: string
- targetMethod: Method
- templateName: string
- provider: string
Returns ControlPointBuilder
Inherited from AutotunerBuilder.addAdaptiveAlg
- Defined in kadabra/Kadabra-JS/src-api/kadabra/adapt/Autotuner.ts:323

addAlgorithm

addAlgorithm(algorithm, id?): ControlPointBuilder
Adds a simple algorithm
Parameters
- algorithm:
      | string
      | Method
      | SimpleAlgorithm
      | AlgorithmWithKnob
- Optionalid: string
Returns ControlPointBuilder
Inherited from AutotunerBuilder.addAlgorithm
- Defined in kadabra/Kadabra-JS/src-api/kadabra/adapt/Autotuner.ts:274

addAlgorithmWithKnob

addAlgorithmWithKnob(algorithm, id, configuration): ControlPointBuilder
Adds an algorithm containing a knob
Parameters
- algorithm: string
- id: string
- configuration: Configuration
Returns ControlPointBuilder
Inherited from AutotunerBuilder.addAlgorithmWithKnob
- Defined in kadabra/Kadabra-JS/src-api/kadabra/adapt/Autotuner.ts:308

addGenerativeAlg

addGenerativeAlg(id, $interface, templateName, provider, providerType, extraArg): ControlPointBuilder
Parameters
- id: string
- $interface: Method
- templateName: string
- provider: string
- providerType: string
- extraArg: string
Returns ControlPointBuilder
Inherited from AutotunerBuilder.addGenerativeAlg
- Defined in kadabra/Kadabra-JS/src-api/kadabra/adapt/Autotuner.ts:334

around

around(ranges, id?): ControlPointBuilder
Parameters
- ranges: PrimitiveRange | PrimitiveRange[]
- id: string = "around"
Returns ControlPointBuilder
- Defined in kadabra/Kadabra-JS/src-api/kadabra/adapt/Autotuner.ts:577

generate

generate(packageName?): AutotunerClass
Parameters
- packageName: string = "kadabra.autotuner"
Returns AutotunerClass
Overrides AutotunerBuilder.generate
- Defined in kadabra/Kadabra-JS/src-api/kadabra/adapt/Autotuner.ts:539

linear

linear(ranges, id?): ControlPointBuilder
Parameters
- ranges: PrimitiveRange | PrimitiveRange[]
- id: string = "linear"
Returns ControlPointBuilder
- Defined in kadabra/Kadabra-JS/src-api/kadabra/adapt/Autotuner.ts:587

normalSampling

normalSampling(): ControlPointBuilder
Set the algorithms sampling in the order they are defined

Returns ControlPointBuilder
Inherited from AutotunerBuilder.normalSampling
- Defined in kadabra/Kadabra-JS/src-api/kadabra/adapt/Autotuner.ts:370

pushAlgorithm

pushAlgorithm(algorithm): ControlPointBuilder
Parameters
- algorithm: Algorithm
Returns ControlPointBuilder
Inherited from AutotunerBuilder.pushAlgorithm
- Defined in kadabra/Kadabra-JS/src-api/kadabra/adapt/Autotuner.ts:354

random

random(ranges, id?): ControlPointBuilder
Parameters
- ranges: PrimitiveRange | PrimitiveRange[]
- id: string = "random"
Returns ControlPointBuilder
- Defined in kadabra/Kadabra-JS/src-api/kadabra/adapt/Autotuner.ts:592

randomSampling

randomSampling(): ControlPointBuilder
Set the algorithms sampling in a random order

Returns ControlPointBuilder
Inherited from AutotunerBuilder.randomSampling
- Defined in kadabra/Kadabra-JS/src-api/kadabra/adapt/Autotuner.ts:362

range

range(ranges, id?): ControlPointBuilder
Parameters
- ranges: PrimitiveRange | PrimitiveRange[]
- id: string = "range"
Returns ControlPointBuilder
- Defined in kadabra/Kadabra-JS/src-api/kadabra/adapt/Autotuner.ts:582

setConcurrent

setConcurrent(conc): ControlPointBuilder
Parameters
- conc: boolean
Returns ControlPointBuilder
- Defined in kadabra/Kadabra-JS/src-api/kadabra/adapt/Autotuner.ts:551

setConfig

setConfig(config, id?): ControlPointBuilder
Adds a simple algorithm
Parameters
- config: Configuration
- Optionalid: string
Returns ControlPointBuilder
- Defined in kadabra/Kadabra-JS/src-api/kadabra/adapt/Autotuner.ts:559

setDefault

setDefault(code): ControlPointBuilder
Parameters
- code: string
Returns ControlPointBuilder
- Defined in kadabra/Kadabra-JS/src-api/kadabra/adapt/Autotuner.ts:546

setMeasurer

setMeasurer(measurer): ControlPointBuilder
Define the code that provides a new algorithm measurer (e.g. weaver.kadabra.control...measurers.AvgLongMeasurer )
Parameters
- measurer: Measurer
Returns ControlPointBuilder
Inherited from AutotunerBuilder.setMeasurer
- Defined in kadabra/Kadabra-JS/src-api/kadabra/adapt/Autotuner.ts:378

withConfig

withConfig(configFunction, ranges, id?): ControlPointBuilder
Parameters
- configFunction: ((knobs: Field | Field[], ranges: PrimitiveRange | PrimitiveRange[]) => Configuration)
  - - (knobs, ranges): Configuration
    - Parameters
      knobs: Field | Field[]
      ranges: PrimitiveRange | PrimitiveRange[]
      Returns Configuration
- ranges: PrimitiveRange | PrimitiveRange[]
- id: string = "user_config"
Returns ControlPointBuilder
- Defined in kadabra/Kadabra-JS/src-api/kadabra/adapt/Autotuner.ts:565