change app file output

Author: isabelizimm

vetiver/__init__.py

@@ -1,6 +1,6 @@
 """vetiver - Python parallel to R vetiver package"""
 
-__version__ = "0.1.4"
+__version__ = "0.1.3"
 __author__ = "Isabel Zimmerman <isabel.zimmerman@rstudio.com>"
 __all__ = []
 

vetiver/pin_read_write.py

@@ -6,10 +6,11 @@
 from .meta import _model_meta
 from .write_fastapi import _choose_version
 
-def vetiver_pin_write(board, model: VetiverModel, versioned: bool=True):
+
+def vetiver_pin_write(board, model: VetiverModel, versioned: bool = True):
     """
     Pin a trained VetiverModel along with other model metadata.
-    
+
     Parameters
     ----------
     board:
@@ -20,16 +21,18 @@ def vetiver_pin_write(board, model: VetiverModel, versioned: bool=True):
         Whether or not the pin should be versioned
     """
     if not board.allow_pickle_read:
-        raise NotImplementedError # must be pickle-able
+        raise NotImplementedError  # must be pickle-able
 
     board.pin_write(
         model.model,
-        name = model.model_name,
-        type = "joblib",
-        description = model.description,
-        metadata = {"required_pkgs": model.metadata.get("required_pkgs"),
-                    "ptype": None if model.ptype == None else model.ptype().json()},
-        versioned=versioned
+        name=model.model_name,
+        type="joblib",
+        description=model.description,
+        metadata={
+            "required_pkgs": model.metadata.get("required_pkgs"),
+            "ptype": None if model.ptype == None else model.ptype().json(),
+        },
+        versioned=versioned,
     )
 
     # to do: Model card
@@ -45,15 +48,15 @@ def vetiver_pin_write(board, model: VetiverModel, versioned: bool=True):
 def vetiver_pin_read(board, name: str, version: str = None) -> VetiverModel:
     """
     Read pin and populate VetiverModel
-    
+
     Parameters
     ----------
     board:
         A pin board, created by `pins.board_folder()` or another `board_` function.
     name: string
         Pin name
     version: str
-        Retrieve a specific version of a pin. 
+        Retrieve a specific version of a pin.
 
     Returns
     --------
@@ -62,26 +65,35 @@ def vetiver_pin_read(board, name: str, version: str = None) -> VetiverModel:
     Notes
     -----
     If reading a board from RSConnect, the `board` argument must be in "username/modelname" format.
-    
+
     """
 
-    raise DeprecationWarning("vetiver_pin_read is now a classmethod VetiverModel.from_pin()")
+    warnings.warn(
+        "vetiver_pin_read will be removed in v1.0.0. Use classmethod VetiverModel.from_pin() instead",
+        DeprecationWarning,
+    )
 
-    version = version if version is not None else _choose_version(board.pin_versions(name))
+    version = (
+        version if version is not None else _choose_version(board.pin_versions(name))
+    )
 
     model = board.pin_read(name, version)
     meta = board.pin_meta(name)
 
-    v = VetiverModel(model = model,
-        model_name = name,
-        description = meta.description,
-        metadata = _model_meta(user = meta.user,
-             version = version,
-             url = meta.user.get("url"), # None all the time, besides Connect
-             required_pkgs = meta.user.get("required_pkgs")
+    v = VetiverModel(
+        model=model,
+        model_name=name,
+        description=meta.description,
+        metadata=_model_meta(
+            user=meta.user,
+            version=version,
+            url=meta.user.get("url"),  # None all the time, besides Connect
+            required_pkgs=meta.user.get("required_pkgs"),
         ),
-        ptype_data = json.loads(meta.user.get("ptype")) if meta.user.get("ptype") else None,
-        versioned = True
-        )
-    
+        ptype_data=json.loads(meta.user.get("ptype"))
+        if meta.user.get("ptype")
+        else None,
+        versioned=True,
+    )
+
     return v

vetiver/tests/test_build_vetiver_model.py

@@ -1,4 +1,3 @@
-from numpy import isin
 import pytest
 import sklearn
 
@@ -77,6 +76,7 @@ def test_vetiver_model_no_ptype():
     assert vt4.model == model
     assert vt4.ptype == None
 
+
 def test_vetiver_model_from_pin():
 
     v = vt.VetiverModel(
@@ -90,7 +90,7 @@ def test_vetiver_model_from_pin():
     board = pins.board_temp(allow_pickle_read=True)
     vt.vetiver_pin_write(board=board, model=v)
     v2 = vt.VetiverModel.from_pin(board, "model")
-    assert isinstance(v2, vt.VetiverModel) 
+    assert isinstance(v2, vt.VetiverModel)
     assert isinstance(v2.model, sklearn.base.BaseEstimator)
     assert isinstance(v2.ptype.construct(), pydantic.BaseModel)
-    board.pin_delete("model")
+    board.pin_delete("model")

vetiver/tests/test_write_app.py

@@ -18,12 +18,13 @@ def test_write_app():
     os.remove(file)
     version = model_board.pin_versions("model").sort_values(by='created', ascending=False)
     version = version.version[0]
-    assert(contents == f"""import vetiver
+    assert(contents == f"""from vetiver import VetiverModel
+import vetiver
 import pins
 
 
 b = pins.board_folder('.', allow_pickle_read=True)
-v = vetiver.vetiver_pin_read(b, 'model', version = '{version}')
+v = VetiverModel.from_pin(b, 'model', version = '{version}')
 
 vetiver_api = vetiver.VetiverAPI(v)
 api = vetiver_api.app

vetiver/write_fastapi.py

@@ -70,18 +70,19 @@ def write_app(board, pin_name: str, version: str = None, file: str = "app.py"):
         if not version:
             version = board.pin_versions(pin_name)
             version = _choose_version(version)
-        pin_read = f"v = vetiver.vetiver_pin_read(b, {repr(pin_name)}, version = {repr(version)})"
+        pin_read = f"v = VetiverModel.from_pin(b, {repr(pin_name)}, version = {repr(version)})"
 
     else:
-        pin_read = f"v = vetiver.pin_read_write.vetiver_pin_read(b, {repr(pin_name)})"
+        pin_read = f"v = VetiverModel.from_pin(b, {repr(pin_name)})"
 
     infra_pkgs = ["vetiver", "pins"]
 
     load_board = pins.board_deparse(board)
 
     f = open(file, "x")
 
-    app = f"""{_glue_required_pkgs(infra_pkgs)}
+    app = f"""from vetiver import VetiverModel
+{_glue_required_pkgs(infra_pkgs)}
 
 b = pins.{load_board}
 {pin_read}