Interface Experiments

interface Experiments {
    createDataset(name: string, description?: string): Dataset;
    createDataset(name: string, options?: CreateDatasetOptions): Dataset;
    experiment(options: ExperimentOptions): Experiment;
    pullDataset(name: string, options?: PullDatasetOptions): Promise<Dataset>;
}

Index

Methods

createDataset experiment pullDataset

Methods

createDataset

createDataset(name: string, description?: string): Dataset
Create a local dataset buffer; pushed on the first experiment run.
Parameters
- name: string
- Optionaldescription: string
Returns Dataset
- Defined in index.d.ts:3880
createDataset(name: string, options?: CreateDatasetOptions): Dataset
Parameters
- name: string
- Optionaloptions: CreateDatasetOptions
Returns Dataset
- Defined in index.d.ts:3881

experiment

experiment(options: ExperimentOptions): Experiment
Build an experiment to run over a dataset.
Parameters
- options: ExperimentOptions
Returns Experiment
- Defined in index.d.ts:3885

pullDataset

pullDataset(name: string, options?: PullDatasetOptions): Promise<Dataset>
Pull an existing dataset (with records) by name.
Parameters
- name: string
- Optionaloptions: PullDatasetOptions
Returns Promise<Dataset>
- Defined in index.d.ts:3883