Description
This library provides an abstraction to perform Model Versioning using Weight & Biases.
Features
- Version a new trained model
- Promote a model to another stage (e.g production)
Example of usage
The following code snippet shows how to promote a newly trained model to the best_model on the validation set. First, it creates the model providing the checkpoint path, the artifact name and type, a description, and the metadata, where the metrics or any desired information is stored.
The comparision_type indicates how to compare the metrics between the two models. E.g if smaller, the smaller the metric from the new model the better
run = wandb.init(...)
# Create the desired artifact
artifact = versioner.create_artifact(
checkpoint='model.ckpt',
artifact_name='prueba',
artifact_type='model',
description='Prueba Wandb-MV',
metadata={
'val_metric': 78.0,
'test_metric': 0.0
})
# Promote the desired artifact to the 'best_model' tag
versioner.promote_model(new_model=artifact,
artifact_name='prueba',
artifact_type='model',
comparision_metric='val_metric',
promotion_alias='best_model',
comparision_type='smaller'
)
This code snippet shows how to promote a trained model to production after being validated on the test set. The already_deployed parameter indicates that the model is already logged, so it only needs to be updated.
versioner = Versioner(run)
versioner.promote_model(new_model=artifact,
artifact_name='prueba',
artifact_type='model',
comparision_metric='test_metric',
promotion_alias='production',
comparision_type='smaller',
already_deployed=True
)
Next features
- Allow providing a custom comparision function to promote a model
- ...
82 Nov 29, 2022
1 Dec 21, 2021
9.6k Dec 31, 2022
210 Jan 4, 2023
18 Oct 12, 2022
1 Oct 30, 2021
2 Jan 5, 2022
3 Nov 18, 2021
49 Nov 5, 2022
69 Nov 28, 2022
22 Jun 14, 2022
42 Jan 3, 2023
39 Dec 8, 2022
4 Jul 27, 2022
284 Jan 4, 2023
42 Dec 9, 2022
145 Dec 30, 2022