IModelRegistry
Interfaces · AiDotNet.TrainingMonitoring.ExperimentTracking
Interface for a model registry that manages model versions and deployments.
Implements: IDisposable
Known implementations: ModelRegistry
How It Works
For Beginners: A Model Registry is like a central library for your trained models. It helps you:
- Store and version models
- Track which model is in production
- Manage model lifecycle (staging -> production -> archived)
- Record model lineage (what data/experiments created this model)
Think of it like the MLflow Model Registry - it’s where your best models get promoted for production use.
Key concepts:
- Registered Model: A named model (e.g., “fraud-detector”)
- Model Version: A specific version of that model (e.g., v1, v2)
- Stage: Where the model is in its lifecycle (Staging, Production, Archived)
- Lineage: The experiment/run/data that created this model
Properties
| Property | Summary |
|---|---|
string RegistryUri { get; } |
Gets the registry URI. |
Methods
| Method | Summary |
|---|---|
DeploymentInfo GetCurrentDeployment(string modelName) |
Gets the current production deployment. |
List<DeploymentInfo> GetDeploymentHistory(string modelName, int version) |
Gets deployment history for a model version. |
List<ModelVersion> ListModelVersions(string modelName, ModelStage[] stages) |
Lists all versions of a model. |
List<ModelVersion> SearchModelVersions(string filter, int maxResults) |
Searches for model versions. |
List<RegisteredModel> ListRegisteredModels(string filter, string orderBy, int maxResults) |
Lists all registered models. |
ModelLineage GetModelLineage(string modelName, int version) |
Gets model lineage information. |
ModelVersion CreateModelVersion(string modelName, string sourcePath, string runId, string description, Dictionary<string, string> tags) |
Creates a new model version. |
ModelVersion GetLatestVersion(string modelName, ModelStage[] stages) |
Gets the latest model version. |
ModelVersion GetModelVersion(string modelName, int version) |
Gets a specific model version. |
RegisteredModel CreateRegisteredModel(string name, string description, Dictionary<string, string> tags) |
Registers a new model or gets existing. |
RegisteredModel GetRegisteredModel(string name) |
Gets a registered model by name. |
string LoadModelArtifacts(string modelUri) |
Loads a model from the registry. |
void DeleteModelVersion(string modelName, int version) |
Deletes a model version. |
void DeleteModelVersionTag(string modelName, int version, string key) |
Deletes a tag from a model version. |
void DeleteRegisteredModel(string name) |
Deletes a registered model and all its versions. |
void RecordDeployment(string modelName, int version, DeploymentInfo deployment) |
Records a deployment of a model version. |
void RecordModelLineage(string modelName, int version, ModelLineage lineage) |
Records model lineage information. |
void SetModelVersionTag(string modelName, int version, string key, string value) |
Sets a tag on a model version. |
void TransitionModelVersionStage(string modelName, int version, ModelStage stage, bool archiveExisting) |
Transitions a model version to a new stage. |
void UpdateModelVersion(string modelName, int version, string description) |
Updates a model version. |
void UpdateRegisteredModel(string name, string description) |
Updates a registered model. |