Model / train
TypeScript
Start a new training session.
Request parameters
{
/** The model's id. */
modelId: string,
/** Which state to use when instantiating the model. Defaults to the active state. */
stateId?: string,
/** A name to give the new state once it is created. */
newStateName: string,
/** Parameters to provide to the train function on the running model. */
params: DecthingsParameterProvider[],
/** Which launcher to use for running the operation. */
executionLocation: {
type: 'persistentLauncher',
persistentLauncherId: string
} | {
type: 'temporaryLauncher',
spec: LauncherSpec
}
}
Where "DecthingsParameterProvider" is defined as:
export type DecthingsParameterProvider = {
name: string,
data: {
type: 'dataset',
datasetId: string,
datasetKey: string
} | {
type: 'data',
data: DecthingsTensor[]
}
}
Response
{
/** If successful. One of "result" and "error" will be present. */
result?: {
/** A unique identifier which you should use in subsequent API calls. */
trainingSessionId: string
},
/** If failed */
error?: {
code: 'model_not_found' | 'persistent_launcher_not_found' | 'snapshot_no_longer_exists' | 'access_denied' | 'quota_exceeded' | 'model_to_mount_no_longer_exists' | 'bad_credentials' | 'too_many_requests' | 'payment_required' | 'unknown'
} | {
code: 'dataset_not_found',
datasetId: string
} | {
code: 'dataset_key_not_found',
datasetId: string,
datasetKey: string
} | {
code: 'invalid_parameter',
parameterName: string,
reason: string
}
}
Example
Following the installation guide to setup the Decthings API for TypeScript. Add your parameters to the following code and run it in Node.js, or in a browser by using a bundler.
The code reads your API key from file. Create an API key and save it to the file "auth.txt". Keep your key safe!
import * as fs from 'fs'
import { DecthingsClient } from '@decthings/api-client'
let apiKey = fs.readFileSync('./auth.txt').toString().trim()
let client = new DecthingsClient({ apiKey })
async function main() {
try {
let response = await client.model.train({
modelId: /* Add modelId here */,
newStateName: /* Add newStateName here */,
params: /* Add params here */,
executionLocation: /* Add executionLocation here */
})
if (result.error) {
// Decthings sent us an error
console.log(response.error)
} else {
// Success!
console.log(response.result)
}
}
catch (e) {
// Client throws an error on connection issues. The function may or may not have succeded
console.log(e)
}
}
main()