update warning

Author: isabelizimm

vetiver/model_card.py

@@ -1,9 +1,6 @@
-import logging
 from importlib_resources import files as _files
 import shutil
 
-_log = logging.getLogger(__name__)
-
 
 def model_card(path="."):
     """Create a model card for documentation
@@ -15,6 +12,4 @@ def model_card(path="."):
     """
     src_path = _files("vetiver") / "templates/model_card.qmd"
 
-    logging.info("Writing model card template:")
-
     return shutil.copy(src=src_path, dst=path)

vetiver/pin_read_write.py

@@ -1,8 +1,19 @@
 import warnings
-
 from .vetiver_model import VetiverModel
 
 
+class ModelCard(UserWarning):
+    def __init__(
+        self,
+        message="""
+        Model Cards provide a framework for transparent, responsible reporting.
+        Use the vetiver `.qmd` Quarto template as a place to start,
+        with vetiver.model_card()""",
+    ):
+        self.message = message
+        super().__init__(self.message)
+
+
 def vetiver_pin_write(board, model: VetiverModel, versioned: bool = True):
     """
     Pin a trained VetiverModel along with other model metadata.
@@ -19,6 +30,9 @@ def vetiver_pin_write(board, model: VetiverModel, versioned: bool = True):
     if not board.allow_pickle_read:
         raise NotImplementedError  # must be pickle-able
 
+    warnings.simplefilter("once", ModelCard)
+    warnings.warn(ModelCard().message)
+
     board.pin_write(
         model.model,
         name=model.model_name,
@@ -31,16 +45,6 @@ def vetiver_pin_write(board, model: VetiverModel, versioned: bool = True):
         versioned=versioned,
     )
 
-    # to do: Model card
-
-    # message = """
-    # Create a Model Card for your published model.
-    # Model Cards provide a framework for transparent, responsible reporting.
-    # Use the vetiver `.qmd` Quarto template as a place to start,
-    # with vetiver.model_card()"""
-
-    # warnings.warn(message=message)
-
 
 def vetiver_pin_read(board, name: str, version: str = None) -> VetiverModel:
     """