Skip to main content

WeaveClient

weave

weave / WeaveClient

Class: WeaveClient

Defined in: weaveClient.ts:81

Constructors​

Constructor​

new WeaveClient(traceServerApi, wandbServerApi, projectId, settings): WeaveClient

Defined in: weaveClient.ts:91

Parameters​

traceServerApi​

Api<any>

wandbServerApi​

WandbServerApi

projectId​

string

settings​

Settings = ...

Returns​

WeaveClient

Properties​

projectId​

projectId: string

Defined in: weaveClient.ts:94

settings​

settings: Settings

Defined in: weaveClient.ts:95

traceServerApi​

traceServerApi: Api<any>

Defined in: weaveClient.ts:92

Methods​

createCall()​

createCall(internalCall, opRef, params, parameterNames, thisArg, currentCall, parentCall, startTime, displayName?): Promise<void>

Defined in: weaveClient.ts:700

Parameters​

internalCall​

InternalCall

opRef​

any

params​

any[]

parameterNames​

ParameterNamesOption

thisArg​

any

currentCall​

CallStackEntry

parentCall​

undefined | CallStackEntry

startTime​

Date

displayName?​

string

Returns​

Promise<void>

finishCall()​

finishCall(call, result, currentCall, parentCall, summarize, endTime, startCallPromise): Promise<void>

Defined in: weaveClient.ts:741

Parameters​

call​

InternalCall

result​

any

currentCall​

CallStackEntry

parentCall​

undefined | CallStackEntry

summarize​

undefined | (result) => Record<string, any>

endTime​

Date

startCallPromise​

Promise<void>

Returns​

Promise<void>

finishCallWithException()​

finishCallWithException(call, error, currentCall, parentCall, endTime, startCallPromise): Promise<void>

Defined in: weaveClient.ts:781

Parameters​

call​

InternalCall

error​

any

currentCall​

CallStackEntry

parentCall​

undefined | CallStackEntry

endTime​

Date

startCallPromise​

Promise<void>

Returns​

Promise<void>

get()​

get(ref): Promise<any>

Defined in: weaveClient.ts:280

Parameters​

ref​

ObjectRef

Returns​

Promise<any>

getCall()​

getCall(callId, includeCosts): Promise<Call>

Defined in: weaveClient.ts:211

Parameters​

callId​

string

includeCosts​

boolean = false

Returns​

Promise<Call>

getCalls()​

getCalls(filter, includeCosts, limit): Promise<Call[]>

Defined in: weaveClient.ts:221

Parameters​

filter​

CallsFilter = {}

includeCosts​

boolean = false

limit​

number = 1000

Returns​

Promise<Call[]>

getCallsIterator()​

getCallsIterator(filter, includeCosts, limit): AsyncIterableIterator<CallSchema>

Defined in: weaveClient.ts:235

Parameters​

filter​

CallsFilter = {}

includeCosts​

boolean = false

limit​

number = 1000

Returns​

AsyncIterableIterator<CallSchema>

getCallStack()​

getCallStack(): CallStack

Defined in: weaveClient.ts:628

Returns​

CallStack

publish()​

publish(obj, objId?): Promise<ObjectRef>

Defined in: weaveClient.ts:199

Parameters​

obj​

any

objId?​

string

Returns​

Promise<ObjectRef>

pushNewCall()​

pushNewCall(): object

Defined in: weaveClient.ts:632

Returns​

object

currentCall​

currentCall: CallStackEntry

newStack​

newStack: CallStack

parentCall?​

optional parentCall: CallStackEntry

runWithCallStack()​

runWithCallStack<T>(callStack, fn): T

Defined in: weaveClient.ts:636

Type Parameters​

T​

T

Parameters​

callStack​

CallStack

fn​

() => T

Returns​

T

saveOp()​

saveOp(op, objId?): Promise<any>

Defined in: weaveClient.ts:666

Parameters​

op​

Op<(...args) => any>

objId?​

string

Returns​

Promise<any>

updateCall()​

updateCall(callId, displayName): Promise<void>

Defined in: weaveClient.ts:817

Parameters​

callId​

string

displayName​

string

Returns​

Promise<void>

waitForBatchProcessing()​

waitForBatchProcessing(): Promise<void>

Defined in: weaveClient.ts:112

Returns​

Promise<void>