vetiver_pin_write

vetiver_pin_write(board, model: VetiverModel, versioned: bool = True)

Pin a trained VetiverModel along with other model metadata.

Parameters

board :

A pin board, created by pins.board_folder() or another board_ function.

model : VetiverModel

VetiverModel to be written to board

versioned : bool = True

Whether or not the pin should be versioned

Examples

import vetiver
from pins import board_temp
model_board = board_temp(versioned = True, allow_pickle_read = True)
X, y = vetiver.get_mock_data()
model = vetiver.get_mock_model().fit(X, y)
v = vetiver.VetiverModel(model, "my_model", prototype_data = X)
vetiver.vetiver_pin_write(model_board, v)

Model Cards provide a framework for transparent, responsible reporting. 
 Use the vetiver `.qmd` Quarto template as a place to start, 
 with vetiver.model_card()
Writing pin:
Name: 'my_model'
Version: 20241210T193455Z-b8f9d