update names

Author: isabelizimm

vetiver/__init__.py

@@ -1,19 +1,19 @@
 """vetiver - Python parallel to R vetiver package"""
 
-__version__ = "0.1.3"
+__version__ = "0.1.4"
 __author__ = "Isabel Zimmerman <isabel.zimmerman@rstudio.com>"
 __all__ = []
 
 import importlib
 from .ptype import *
-from .vetiver_model import *
-from .server import *
-from .mock import *
-from .pin_read_write import *
+from .vetiver_model import VetiverModel
+from .server import VetiverAPI, vetiver_endpoint
+from .mock import get_mock_data, get_mock_model
+from .pin_read_write import vetiver_pin_write
 from .attach_pkgs import *
 from .meta import *
-from .write_docker import *
-from .write_fastapi import * 
+from .write_docker import write_docker
+from .write_fastapi import write_app
 from .handlers._interface import create_handler, InvalidModelError
 from .handlers.base import VetiverHandler
 from .handlers.sklearn import SKLearnHandler

vetiver/meta.py

@@ -1,4 +1,4 @@
-def vetiver_meta(user: dict = None, version: str = None,
+def _model_meta(user: dict = None, version: str = None,
             url: str = None, required_pkgs: list = None):
     """Populate relevant metadata for VetiverModel
 

vetiver/pin_read_write.py

@@ -4,7 +4,7 @@
 import json
 
 from .vetiver_model import VetiverModel
-from .meta import vetiver_meta
+from .meta import _model_meta
 from .write_fastapi import _choose_version
 
 def vetiver_pin_write(board, model: VetiverModel, versioned: bool=True):
@@ -65,6 +65,9 @@ def vetiver_pin_read(board, name: str, version: str = None) -> VetiverModel:
     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()")
+
     version = version if version is not None else _choose_version(board.pin_versions(name))
 
     model = board.pin_read(name, version)
@@ -73,7 +76,7 @@ def vetiver_pin_read(board, name: str, version: str = None) -> VetiverModel:
     v = VetiverModel(model = model,
         model_name = name,
         description = meta.description,
-        metadata = vetiver_meta(user = meta.user,
+        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")

vetiver/tests/test_build_vetiver_model.py

@@ -2,9 +2,11 @@
 
 from vetiver.vetiver_model import VetiverModel
 from vetiver.mock import get_mock_data, get_mock_model
+from vetiver.pin_read_write import pin_write
 
 import pandas as pd
-from numpy import int64
+import pydantic
+import pins
 
 # Load data, model
 X_df, y = get_mock_data()
@@ -24,6 +26,7 @@ def test_vetiver_model_array_ptype():
     )
 
     assert vt1.model == model
+    assert isinstance(vt1.ptype.construct(), pydantic.BaseModel)
     assert list(vt1.ptype.__fields__.values())[0].type_ == int
 
 
@@ -39,6 +42,7 @@ def test_vetiver_model_df_ptype():
     )
 
     assert vt2.model == model
+    assert isinstance(vt2.ptype.construct(), pydantic.BaseModel)
     assert list(vt2.ptype.__fields__.values())[0].type_ == int
 
 
@@ -54,6 +58,7 @@ def test_vetiver_model_dict_ptype():
     )
 
     assert vt3.model == model
+    assert isinstance(vt3.ptype.construct(), pydantic.BaseModel)
     assert list(vt3.ptype.__fields__.values())[0].type_ == int
 
 
@@ -70,3 +75,21 @@ def test_vetiver_model_no_ptype():
 
     assert vt4.model == model
     assert vt4.ptype == None
+
+def test_vetiver_model_from_pin():
+
+    v = VetiverModel(
+        model=model,
+        ptype_data=None,
+        model_name="iris",
+        versioned=None,
+        description=None,
+        metadata=None,
+    )
+    board = pins.board_temp(allow_pickle_read=True)
+    vetiver_pin_write(board=board, model=v)
+    v = VetiverModel.from_pin(board, "model")
+    assert isinstance(v, VetiverModel) 
+    assert vt5.model == model
+    assert isinstance(vt5.ptype.construct(), pydantic.BaseModel)
+    board.pin_delete("model")

vetiver/tests/test_write_app.py

@@ -7,13 +7,13 @@
 X_df, y = vetiver.get_mock_data()
 model = vetiver.get_mock_model().fit(X_df, y)
 
-def test_vetiver_write_app():
+def test_write_app():
     file = "app.py"
     v = vetiver.VetiverModel(model=model, ptype_data=X_df,
          model_name="model", versioned=None)
     model_board = pins.board_folder(path=".", versioned=True, allow_pickle_read=True)
     vetiver.vetiver_pin_write(board=model_board, model=v)
-    vetiver.vetiver_write_app(model_board, "model", file = "app.py")
+    vetiver.write_app(model_board, "model", file = "app.py")
     contents = open(file).read()
     os.remove(file)
     version = model_board.pin_versions("model").sort_values(by='created', ascending=False)

vetiver/tests/test_write_docker.py

@@ -10,7 +10,7 @@
 def test_vetiver_write_app_no_rspm():
     py_version = str(sys.version_info.major) + "." + str(sys.version_info.minor)
     file = "Dockerfile"
-    vetiver.vetiver_write_docker(rspm_env=False, path = "./")
+    vetiver.write_docker(rspm_env=False, path = "./")
     contents = open(file).read()
     os.remove(file)
     assert(contents == f"""# # Generated by the vetiver package; edit with care
@@ -38,7 +38,7 @@ def test_vetiver_write_app_no_rspm():
 
 def test_vetiver_write_app_rspm():
     file = "Dockerfile"
-    vetiver.vetiver_write_docker(rspm_env=True, path = "./")
+    vetiver.write_docker(rspm_env=True, path = "./")
     contents = open(file).read()
     os.remove(file)
     py_version = str(sys.version_info.major) + "." + str(sys.version_info.minor)

vetiver/vetiver_model.py

@@ -1,4 +1,9 @@
+import json
+
 from vetiver.handlers._interface import create_handler
+from .meta import _model_meta
+from .write_fastapi import _choose_version
+
 
 
 class NoModelAvailableError(Exception):
@@ -62,11 +67,38 @@ def __init__(
         self.model = translator.model
         self.ptype = translator.construct_ptype()
         self.model_name = model_name
-        self.description = description if description else translator.describe()
+        self.description = (
+            description if description else translator.describe()
+        )
         self.versioned = versioned
-        self.metadata = translator.create_meta(
+        self.metadata = metadata if metadata else translator.create_meta(
             metadata, required_pkgs=["vetiver"]
         )
         self.handler_predict = translator.handler_predict
 
-        
+    @classmethod
+    def from_pin(cls, board, name: str, version: str = None):
+        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)
+
+        return cls(
+            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,
+        )

vetiver/write_docker.py

@@ -1,10 +1,32 @@
 import sys
+import warnings
 
-def vetiver_write_docker(app_file: str = "app.py",
+
+def vetiver_write_docker(
+    app_file: str = "app.py",
     path: str = "./",
     rspm_env: bool = False,
     host: str = "0.0.0.0",
-    port: str = "8080"):
+    port: str = "8080",
+):
+
+    warnings.warn(
+        "vetiver_write_docker will be replaced by write_docker in v1.0.0",
+        DeprecationWarning,
+    )
+
+    return write_docker(
+        app_file=app_file, path=path, rspm_env=rspm_env, host=host, port=port
+    )
+
+
+def write_docker(
+    app_file: str = "app.py",
+    path: str = "./",
+    rspm_env: bool = False,
+    host: str = "0.0.0.0",
+    port: str = "8080",
+):
     """Writes a Dockerfile to run VetiverAPI in a container
 
     Args
@@ -27,7 +49,6 @@ def vetiver_write_docker(app_file: str = "app.py",
     else:
         rspm = ""
 
-
     docker_script = f"""# # Generated by the vetiver package; edit with care
 # start with python base image
 FROM python:{py_version}

vetiver/write_fastapi.py

@@ -2,6 +2,7 @@
 import pandas as pd
 import warnings
 
+
 def _choose_version(df: pd.DataFrame):
     """Choose pin version to load
 
@@ -10,10 +11,10 @@ def _choose_version(df: pd.DataFrame):
     df: pd.DataFrame
         Available pins versions
     """
-    if 'active' in df.columns:
+    if "active" in df.columns:
         version = df.active[0]
-    elif 'created' in df.columns: 
-        version_desc = df.sort_values(by='created', ascending=False)
+    elif "created" in df.columns:
+        version_desc = df.sort_values(by="created", ascending=False)
         version = version_desc.version[0]
     else:
         version = df.version[0]
@@ -24,6 +25,7 @@ def _choose_version(df: pd.DataFrame):
         )
     return version
 
+
 def _glue_required_pkgs(required_pkgs: list):
     """Generate import statements
 
@@ -39,8 +41,17 @@ def _glue_required_pkgs(required_pkgs: list):
 
     return load_required_pkgs
 
-def vetiver_write_app(board, pin_name: str,
-              version: str = None, file: str = "app.py"):
+
+def vetiver_write_app(board, pin_name: str, version: str = None, file: str = "app.py"):
+
+    warnings.warn(
+        "vetiver_write_app will be replaced by write_app in v1.0.0", DeprecationWarning
+    )
+
+    return write_app(board=board, pin_name=pin_name, version=version, file=file)
+
+
+def write_app(board, pin_name: str, version: str = None, file: str = "app.py"):
     """Write VetiverAPI app to a file
 
     Args
@@ -49,9 +60,9 @@ def vetiver_write_app(board, pin_name: str,
         API to be written
     pin_name : string
         Name of pin containing VetiverModel
-    version : 
+    version :
         Pins version of VetiverModel
-    file : 
+    file :
         Name of file
     """
 
@@ -60,15 +71,14 @@ def vetiver_write_app(board, pin_name: str,
             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)})"
-        
+
     else:
         pin_read = f"v = vetiver.pin_read_write.vetiver_pin_read(b, {repr(pin_name)})"
 
-    infra_pkgs = ['vetiver', 'pins']
-
+    infra_pkgs = ["vetiver", "pins"]
 
     load_board = pins.board_deparse(board)
-    
+
     f = open(file, "x")
 
     app = f"""{_glue_required_pkgs(infra_pkgs)}