Skip to main content

Dataset

weave

weave / Dataset

Class: Dataset<R>

Defined in: dataset.ts:48

Dataset object with easy saving and automatic versioning

Example​

// Create a dataset
const dataset = new Dataset({
  id: 'grammar-dataset',
  rows: [
    { id: '0', sentence: "He no likes ice cream.", correction: "He doesn't like ice cream." },
    { id: '1', sentence: "She goed to the store.", correction: "She went to the store." },
    { id: '2', sentence: "They plays video games all day.", correction: "They play video games all day." }
  ]
})

// Access a specific example
const exampleLabel = dataset.getRow(2).sentence;

// Save the dataset
const ref = await dataset.save()

Extends​

Type Parameters​

R​

R extends DatasetRow

Constructors​

Constructor​

new Dataset<R>(parameters): Dataset<R>

Defined in: dataset.ts:51

Parameters​

parameters​

DatasetParameters<R>

Returns​

Dataset<R>

Overrides​

WeaveObject.constructor

Properties​

__savedRef?​

optional __savedRef: ObjectRef | Promise<ObjectRef>

Defined in: weaveObject.ts:49

Inherited from​

WeaveObject.__savedRef

_baseParameters​

protected _baseParameters: WeaveObjectParameters

Defined in: weaveObject.ts:51

Inherited from​

WeaveObject._baseParameters

rows​

rows: Table<R>

Defined in: dataset.ts:49

Accessors​

description​

Get Signature​

get description(): undefined | string

Defined in: weaveObject.ts:80

Returns​

undefined | string

Inherited from​

WeaveObject.description

length​

Get Signature​

get length(): number

Defined in: dataset.ts:64

Returns​

number

name​

Get Signature​

get name(): string

Defined in: weaveObject.ts:76

Returns​

string

Inherited from​

WeaveObject.name

Methods​

[asyncIterator]()​

[asyncIterator](): AsyncIterator<any>

Defined in: dataset.ts:68

Returns​

AsyncIterator<any>

className()​

className(): any

Defined in: weaveObject.ts:53

Returns​

any

Inherited from​

WeaveObject.className

getRow()​

getRow(index): R

Defined in: dataset.ts:74

Parameters​

index​

number

Returns​

R

save()​

save(): Promise<ObjectRef>

Defined in: dataset.ts:60

Returns​

Promise<ObjectRef>

saveAttrs()​

saveAttrs(): object

Defined in: weaveObject.ts:57

Returns​

object

Inherited from​

WeaveObject.saveAttrs