Class MlTrainingClient

Constructors

Methods

  • Cancel a training job.

    Parameters

    • id: string

      The training job ID.

    Returns Promise<null>

    await mlTrainingClient.cancelTrainingJob('<training-job-id>');
    

    For more information, see ML Training API.

  • Delete a completed training job.

    Parameters

    • id: string

      The training job ID.

    Returns Promise<null>

    await mlTrainingClient.deleteCompletedTrainingJob('<training-job-id>');
    

    For more information, see ML Training API.

  • Get a training job metadata.

    Parameters

    • id: string

      The training job ID.

    Returns Promise<undefined | TrainingJobMetadata>

    const job = await mlTrainingClient.getTrainingJob('<training-job-id>');
    

    For more information, see ML Training API.

  • List training jobs.

    Parameters

    • organizationId: string

      The organization ID.

    • status: TrainingStatus

      The training job status.

    Returns Promise<TrainingJobMetadata[]>

    const jobs = await mlTrainingClient.listTrainingJobs(
    '<organization-id>',
    TrainingStatus.RUNNING
    );

    For more information, see ML Training API.

  • Submit a training job from a custom training script.

    Parameters

    • organizationId: string

      The organization ID.

    • datasetId: string

      The dataset ID.

    • registryItemId: string

      The registry item ID.

    • registryItemVersion: string

      The registry item version.

    • modelName: string

      The model name.

    • modelVersion: string

      The model version.

    Returns Promise<string>

    await mlTrainingClient.submitCustomTrainingJob(
    '<organization-id>',
    '<dataset-id>',
    'viam:classification-tflite',
    '1.0.0',
    '<your-model-name>',
    '1.0.0'
    );

    For more information, see ML Training API.

  • Submit a training job.

    Parameters

    • organizationId: string

      The organization ID.

    • datasetId: string

      The dataset ID.

    • modelName: string

      The model name.

    • modelVersion: string

      The model version.

    • modelType: ModelType

      The model type.

    • tags: string[]

      The tags.

    Returns Promise<string>

    await mlTrainingClient.submitTrainingJob(
    '<organization-id>',
    '<dataset-id>',
    '<your-model-name>',
    '1.0.0',
    ModelType.SINGLE_LABEL_CLASSIFICATION,
    ['tag1', 'tag2']
    );

    For more information, see ML Training API.

MMNEPVFCICPMFPCPTTAAATR