vetiver.deploy_rsconnect
vetiver.deploy_rsconnect#
- vetiver.deploy_rsconnect(connect_server, board, pin_name: str, version: Optional[str] = None, extra_files: Optional[List[str]] = None, new: bool = False, app_id: Optional[int] = None, title: Optional[str] = None, python: Optional[str] = None, conda_mode: bool = False, force_generate: bool = False, log_callback: Optional[Callable] = None, image: Optional[str] = None)#
Deploy to Posit Connect
- Parameters
connect_server (rsconnect.api.RSConnectServer) – Posit Connect Server
board – Pins board
pin_name (str) – Name of pin
version (str) – Version of pin
extra_files (List[str]) – Any extra files to include
new (bool) – Force as a new deploy
app_id (int) – ID of an existing application to deploy new files for.
title (str) – Optional title for the deploy.
python (str) – Optional name of a Python executable
conda_mode (bool) – Use conda to build an environment.yml
force_generate (bool) – Force generating requirements.txt or environment.yml
log_callback (Callable) – Callback to use to write the log to
image (str) – Docker image to be specified for off-host execution
Examples
>>> import vetiver >>> import pins >>> import rsconnect >>> board = pins.board_temp(allow_pickle_read=True) >>> connect_server = rsconnect.api.RSConnectServer( ... url = url, ... api_key = api_key) >>> X, y = vetiver.get_mock_data() >>> model = vetiver.get_mock_model().fit(X, y) >>> v = vetiver.VetiverModel(model = model, ... model_name = "my_model", ... prototype_data = X) >>> vetiver.deploy_rsconnect( ... connect_server = connect_server, ... board = board, ... pin_name = "my_model" ... )