Viam SDK
    Preparing search index...

    Class MLTrainingMetadata

    from message viam.app.v1.MLTrainingMetadata

    Hierarchy

    Index
    deploymentModularResources: string[]

    Colon-delimited triplets of components or services from the registry used when model_framework is MODEL_FRAMEWORK_REGISTRY. This ties the ML model file to the associated component or service that consumes the files and should be deployed along with the model. Copied onto packages published by this training script.

    from field: repeated string deployment_modular_resources = 6;

    draft: boolean

    from field: bool draft = 4;

    modelFramework: ModelFramework

    from field: viam.app.mltraining.v1.ModelFramework model_framework = 3;

    modelType: ModelType

    from field: viam.app.mltraining.v1.ModelType model_type = 2;

    versions: MLTrainingVersion[]

    A list of package versions for ML training source distribution

    from field: repeated viam.app.v1.MLTrainingVersion versions = 5;

    fields: FieldList
    runtime: ProtoRuntime
    typeName: "viam.app.v1.MLTrainingMetadata"
    • Parse from binary data, merging fields.

      Repeated fields are appended. Map entries are added, overwriting existing keys.

      If a message field is already present, it will be merged with the new data.

      Parameters

      • bytes: Uint8Array
      • Optionaloptions: Partial<BinaryReadOptions>

      Returns this

    • Parse a message from a JSON value.

      Parameters

      • jsonValue: JsonValue
      • Optionaloptions: Partial<JsonReadOptions>

      Returns this

    • Parse a message from a JSON string.

      Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns this

    • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

      Returns MessageType<MLTrainingMetadata>

    • Serialize the message to binary data.

      Parameters

      • Optionaloptions: Partial<BinaryWriteOptions>

      Returns Uint8Array

    • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

      Parameters

      • Optionaloptions: Partial<JsonWriteOptions>

      Returns JsonValue

    • Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

      Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

      This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

      Returns JsonValue

    • Serialize the message to a JSON string.

      Parameters

      • Optionaloptions: Partial<JsonWriteStringOptions>

      Returns string

    • Parameters

      • bytes: Uint8Array
      • Optionaloptions: Partial<BinaryReadOptions>

      Returns MLTrainingMetadata

    • Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns MLTrainingMetadata