From 0de74c3ee6d1737d4275a11d3cd4a736089a7178 Mon Sep 17 00:00:00 2001 From: Heather MacDonald <80712961+hmacdonald-verta@users.noreply.github.com> Date: Tue, 30 May 2023 16:28:34 -0700 Subject: [PATCH] docs: Update set_pii docstring (#3839) --- .../verta/verta/registry/entities/_model.py | 22 ++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/client/verta/verta/registry/entities/_model.py b/client/verta/verta/registry/entities/_model.py index 6f6565abf7..8a20c1dc66 100644 --- a/client/verta/verta/registry/entities/_model.py +++ b/client/verta/verta/registry/entities/_model.py @@ -1090,13 +1090,33 @@ def _create_proto_internal( def set_pii(self, pii): """ - Note that you *MUST* update any live endpoints running this model in order to propagate this change. + Updates the PII value of this Registered Model. + + + Parameters + ---------- + pii : bool + ``True`` indicates that the model ingests personally identifiable information. + + Warnings + -------- + You *MUST* update any live endpoints running this model in order to propagate this change. + A simple no-op update is sufficient. """ self._fetch_with_no_cache() self._msg.pii = pii self._update(self._msg, method="PUT") def get_pii(self): + """ + Returns the PII value of this Registered Model. + + Returns + ------- + bool + ``True`` indicates that the model ingests personally identifiable information. + + """ self._refresh_cache() return self._msg.pii