Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Update set_pii docstring #3839

Merged
merged 3 commits into from May 30, 2023
Merged

docs: Update set_pii docstring #3839

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5d1300f
docs: Update set_pii docstring
hmacdonald-verta May 30, 2023
20dd67f
Update client/verta/verta/registry/entities/_model.py
hmacdonald-verta May 30, 2023
bdcf8a6
More docs
hmacdonald-verta May 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 21 additions & 1 deletion client/verta/verta/registry/entities/_model.py
View file
Open in desktop
Expand Up @@ -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

Expand Down