Class DistillationSpec

Namespace

Google.GenAI.Types

Assembly

Google.GenAI.dll

Distillation tuning spec for tuning.

public record DistillationSpec : IEquatable<DistillationSpec>

Inheritance

object

DistillationSpec

Implements

IEquatable<DistillationSpec>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

BaseTeacherModel

The base teacher model that is being distilled. See Supported models (https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models).

[JsonPropertyName("baseTeacherModel")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? BaseTeacherModel { get; set; }

Property Value

string

HyperParameters

Optional. Hyperparameters for Distillation.

[JsonPropertyName("hyperParameters")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public DistillationHyperParameters? HyperParameters { get; set; }

Property Value

DistillationHyperParameters

PipelineRootDirectory

Deprecated. A path in a Cloud Storage bucket, which will be treated as the root output directory of the distillation pipeline. It is used by the system to generate the paths of output artifacts.

[JsonPropertyName("pipelineRootDirectory")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? PipelineRootDirectory { get; set; }

Property Value

string

PromptDatasetUri

Optional. Cloud Storage path to file containing prompt dataset for distillation. The dataset must be formatted as a JSONL file.

[JsonPropertyName("promptDatasetUri")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? PromptDatasetUri { get; set; }

Property Value

string

StudentModel

The student model that is being tuned, e.g., "google/gemma-2b-1.1-it". Deprecated. Use base_model instead.

[JsonPropertyName("studentModel")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? StudentModel { get; set; }

Property Value

string

TrainingDatasetUri

Deprecated. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file.

[JsonPropertyName("trainingDatasetUri")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? TrainingDatasetUri { get; set; }

Property Value

string

TunedTeacherModelSource

The resource name of the Tuned teacher model. Format: projects/{project}/locations/{location}/models/{model}.

[JsonPropertyName("tunedTeacherModelSource")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? TunedTeacherModelSource { get; set; }

Property Value

string

TuningMode

Optional. Specifies the tuning mode for distillation (sft part). This feature is only available for open source models.

[JsonPropertyName("tuningMode")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public TuningMode? TuningMode { get; set; }

Property Value

TuningMode?

ValidationDatasetUri

Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file.

[JsonPropertyName("validationDatasetUri")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? ValidationDatasetUri { get; set; }

Property Value

string

Methods

FromJson(string, JsonSerializerOptions?)

Deserializes a JSON string to a DistillationSpec object.

public static DistillationSpec? FromJson(string jsonString, JsonSerializerOptions? options = null)

Parameters

jsonString string

The JSON string to deserialize.

options JsonSerializerOptions

Optional JsonSerializerOptions.

Returns

DistillationSpec

The deserialized DistillationSpec object, or null if deserialization fails.