Understanding Model Keys

ZETIC Melange uses two types of keys to manage model access and authentication: Model Identifiers and Personal Keys.

Model Identifier

Every model in Melange is referenced using the format username/repository_name. This identifier is used when initializing the model in your application.

username/my-model-repository

Repository Structure

A Repository acts as a version control container for a specific model lineage. It maintains distinct versions of your artifacts.

username/my-model-repository
├── v1 (uploaded 2024-01-15)
├── v2 (uploaded 2024-02-20) ← default
└── v3 (uploaded 2024-03-10) ← latest

Versioning Policy

• Implicit Latest: Clients automatically pull the most recent upload unless pinned.
• Default Pinning: Administrators can designate a specific stable version as default for production channels.
• Immutable History: All uploaded versions are preserved for rollback capabilities.

Using Model Identifiers in Code

val model = ZeticMLangeModel(
    context,
    BuildConfig.PERSONAL_KEY,
    "USERID/REPOSITORY_NAME" // Automatically resolves to 'default' or 'latest'
)

let model = try ZeticMLangeModel(
    personalKey: personalKey,
    name: "USERID/REPOSITORY_NAME" // Automatically resolves to 'default' or 'latest'
)

Personal Key

The Personal Key is your persistent credential for SDK authentication and API access. Treat it as a high-value secret.

Generating a Personal Key

1. Log in to the Melange Dashboard.
2. Access Settings then Personal Key.
3. Select Generate New Key.
4. Copy immediately: the key is displayed only once.

Best Practices

• Never hardcode personal keys directly in source code. Use environment variables or build configuration.
• Rotate keys periodically for security.
• Use separate keys for development and production environments.

val model = ZeticMLangeModel(
    context,
    BuildConfig.PERSONAL_KEY,  // From build configuration
    "USERID/REPOSITORY_NAME"
)

let model = try ZeticMLangeModel(
    personalKey: Configuration.personalKey,  // From config
    name: "USERID/REPOSITORY_NAME"
)

Deployment Status

Monitor the compilation and optimization status of your models on the dashboard:

Next Steps

• Web Dashboard: Manage repositories and models
• CLI: Deploy via command line
• Performance-Adaptive Deployment: How Melange optimizes for each device