Language

BaseModelReference Class

Definition

The base model a custom model was trained from. A HuggingFace repository supplied by the user because the platform may lack access to private source repositories.

public class BaseModelReference : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ContainerServiceAIManager.Models.BaseModelReference>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ContainerServiceAIManager.Models.BaseModelReference>
type BaseModelReference = class
    interface IJsonModel<BaseModelReference>
    interface IPersistableModel<BaseModelReference>
Public Class BaseModelReference
Implements IJsonModel(Of BaseModelReference), IPersistableModel(Of BaseModelReference)
Inheritance
BaseModelReference
Implements

Constructors

Name Description
BaseModelReference(String)

Initializes a new instance of BaseModelReference.

Properties

Name Description
Config

The verbatim config.json of the base model, supplied by the user. Required if the base model is not publicly accessible on HuggingFace. For more information on CustomAIModel configuration see https://aka.ms/aks/aim-customaimodel.

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""). : Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.

Id

The HuggingFace &lt;org&gt;/&lt;repo&gt; id of the base model, e.g. meta-llama/Llama-2-7b-chat. Immutable after creation.

TotalWeightSizeBytes

The total size of the model weights in bytes. eg 28000000000. Required if the base model is not publicly accessible on HuggingFace.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<BaseModelReference>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<BaseModelReference>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<BaseModelReference>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<BaseModelReference>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<BaseModelReference>.Write(ModelReaderWriterOptions)

Applies to