BAI-1246 Python Logging

lib/python/docs/notebooks/access_requests_demo.ipynb

@@ -190,9 +190,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": ".venv",
    "language": "python",
-   "name": "python"
+   "name": "python3"
   },
   "language_info": {
    "codemirror_mode": {

lib/python/docs/notebooks/datacards_demo.ipynb

@@ -45,15 +45,6 @@
     "In order to create helper classes, you will first need to instantiate a `Client()` object from the core. By default, this object will not support any authentication. However, Bailo also supports PKI authentication, which you can use from Python by passing a `PkiAgent()` object into the `Client()` object when you instantiate it."
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "! pip install bailo -e ../.."
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": null,

lib/python/src/bailo/__init__.py

@@ -5,10 +5,10 @@
 Bailo is a ecosystem for managing the lifecycle of managing machine learning models. This package provides support for interacting with models within Bailo.
 """
 from __future__ import annotations
+import logging
 
-
-# Package Version 2.3.1
-__version__ = "2.3.1"
+# Package Version 2.3.2
+__version__ = "2.3.2"
 
 
 from bailo.core.agent import Agent, PkiAgent, TokenAgent
@@ -19,3 +19,6 @@
 from bailo.helper.model import Experiment, Model
 from bailo.helper.release import Release
 from bailo.helper.schema import Schema
+
+
+logging.getLogger(__name__).addHandler(logging.NullHandler())

lib/python/src/bailo/core/agent.py

@@ -5,9 +5,12 @@
 import requests
 import os
 import getpass
+import logging
 from requests.auth import HTTPBasicAuth
 from bailo.core.exceptions import BailoException, ResponseException
 
+logger = logging.getLogger(__name__)
+
 
 class Agent:
     """Base API Agent for talking with Bailo.
@@ -108,16 +111,24 @@ def __init__(
         super().__init__()
 
         if access_key is None:
+            logger.info("Access key not provided. Trying other sources...")
             try:
                 access_key = os.environ["BAILO_ACCESS_KEY"]
+                logger.info("Access key acquired from BAILO_ACCESS_KEY environment variable.")
             except KeyError:
+                logger.info("Access key not found in BAILO_ACCESS_KEY environment variable. Requires user input.")
                 access_key = getpass.getpass("BAILO ACCESS KEY:")
+                logger.info("Access key acquired from user input.")
 
         if secret_key is None:
+            logger.info("Secret key not provided. Trying other sources...")
             try:
                 secret_key = os.environ["BAILO_SECRET_KEY"]
+                logger.info("Secret key acquired from BAILO_SECRET_KEY environment variable.")
             except KeyError:
+                logger.info("Secret key not found in BAILO_SECRET_KEY environment variable. Requires user input.")
                 secret_key = getpass.getpass("BAILO SECRET KEY:")
+                logger.info("Secret key acquired from user input.")
 
         self.access_key = access_key
         self.secret_key = secret_key

lib/python/src/bailo/helper/access_request.py

@@ -1,9 +1,12 @@
 from __future__ import annotations
 
 from typing import Any
+import logging
 
 from bailo.core.client import Client
 
+logger = logging.getLogger(__name__)
+
 
 class AccessRequest:
     """Represent a review within Bailo.
@@ -53,6 +56,8 @@ def from_id(cls, client: Client, model_id: str, access_request_id: str) -> Acces
 
         schema_id = json_access_request["schemaId"]
 
+        logger.info(f"Access request %s for model %s successfully retrieved from server.", access_request_id, model_id)
+
         return cls(
             client,
             model_id,
@@ -82,6 +87,10 @@ def create(cls, client: Client, model_id: str, schema_id: str, metadata: Any) ->
         metadata = access_request_json["metadata"]
         created_by = access_request_json["createdBy"]
 
+        logger.info(
+            f"Access request successfully created on server with ID %s for model %s.", access_request_id, model_id
+        )
+
         return cls(
             client,
             model_id,
@@ -98,12 +107,17 @@ def delete(self) -> bool:
         :return: A message confirming the removal of the access request.
         """
         self.client.delete_access_request(self.model_id, self.access_request_id)
+
+        logger.info(f"Access request %s successfully deleted on server.", self.access_request_id)
+
         return True
 
     def update(self):
         """Update the current state of the access request to Bailo."""
         self.client.patch_access_request(self.model_id, self.access_request_id, metadata=self.metadata)
 
+        logger.info(f"Access request %s successfully updated on server.", self.access_request_id)
+
     def __str__(self) -> str:
         return f"Access Request: {self.metadata['overview']['name']} - {self.model_id}"
 

lib/python/src/bailo/helper/datacard.py

@@ -1,12 +1,15 @@
 from __future__ import annotations
 
 from typing import Any
+import logging
 
 from bailo.core.client import Client
 from bailo.core.enums import EntryKind, ModelVisibility
 from bailo.core.exceptions import BailoException
 from bailo.helper.entry import Entry
 
+logger = logging.getLogger(__name__)
+
 
 class Datacard(Entry):
     """Represent a datacard within Bailo.
@@ -58,9 +61,12 @@ def create(
         res = client.post_model(
             name=name, kind=EntryKind.DATACARD, description=description, team_id=team_id, visibility=visibility
         )
+        datacard_id = res["model"]["id"]
+        logger.info(f"Datacard successfully created on server with ID %s.", datacard_id)
+
         datacard = cls(
             client=client,
-            datacard_id=res["model"]["id"],
+            datacard_id=datacard_id,
             name=name,
             description=description,
             visibility=visibility,
@@ -84,6 +90,8 @@ def from_id(cls, client: Client, datacard_id: str) -> Datacard:
                 f"ID {datacard_id} does not belong to a datacard. Did you mean to use Model.from_id()?"
             )
 
+        logger.info(f"Datacard %s successfully retrieved from server.", datacard_id)
+
         datacard = cls(
             client=client,
             datacard_id=datacard_id,

lib/python/src/bailo/helper/entry.py

@@ -1,11 +1,14 @@
 from __future__ import annotations
 
 from typing import Any
+import logging
 
 from bailo.core.client import Client
 from bailo.core.enums import EntryKind, ModelVisibility
 from bailo.core.exceptions import BailoException
 
+logger = logging.getLogger(__name__)
+
 
 class Entry:
     def __init__(
@@ -40,6 +43,8 @@ def update(self) -> None:
         )
         self._unpack(res["model"])
 
+        logger.info(f"ID %s updated locally and on server.", self.id)
+
     def card_from_schema(self, schema_id: str) -> None:
         """Create a card using a schema on Bailo.
 
@@ -48,6 +53,8 @@ def card_from_schema(self, schema_id: str) -> None:
         res = self.client.model_card_from_schema(model_id=self.id, schema_id=schema_id)
         self.__unpack_card(res["card"])
 
+        logger.info(f"Card for ID %s successfully created using schema ID %s.", self.id, schema_id)
+
     def card_from_template(self):
         """Create a card using a template (not yet implemented).
 
@@ -60,6 +67,7 @@ def get_card_latest(self) -> None:
         res = self.client.get_model(model_id=self.id)
         if "card" in res["model"]:
             self.__unpack_card(res["model"]["card"])
+            logger.info(f"Latest card for ID %s successfully retrieved.", self.id)
         else:
             raise BailoException(f"A model card doesn't exist for model {self.id}")
 
@@ -71,6 +79,8 @@ def get_card_revision(self, version: str) -> None:
         res = self.client.get_model_card(model_id=self.id, version=version)
         self.__unpack_card(res["modelCard"])
 
+        logger.info(f"Card version %s for ID %s successfully retrieved.", version, self.id)
+
     def get_roles(self):
         """Get all roles for the entry.
 
@@ -96,6 +106,8 @@ def _update_card(self, card: dict[str, Any] | None = None) -> None:
         res = self.client.put_model_card(model_id=self.id, metadata=card)
         self.__unpack_card(res["card"])
 
+        logger.info(f"Card for %s successfully updated on server.", self.id)
+
     def _unpack(self, res):
         self.id = res["id"]
         self.name = res["name"]
@@ -106,6 +118,8 @@ def _unpack(self, res):
         else:
             self.visibility = ModelVisibility.PUBLIC
 
+        logger.info(f"Attributes for ID %s successfully unpacked.", self.id)
+
     def __unpack_card(self, res):
         self._card_version = res["version"]
         self._card_schema = res["schemaId"]
@@ -114,3 +128,5 @@ def __unpack_card(self, res):
             self._card = res["metadata"]
         except KeyError:
             self._card = None
+
+        logger.info(f"Card attributes for ID %s successfully unpacked.", self.id)