Skip to content

Commit 580696f

Browse files
committed
update docstring
1 parent 2785c57 commit 580696f

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

src/sasctl/tasks.py

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -411,8 +411,13 @@ def submit_request():
411411
return module
412412

413413

414-
def update_performance(data, model, label, exec=True):
415-
"""Upload data for calculating model performance metrics
414+
def update_performance(data, model, label, refresh=True):
415+
"""Upload data for calculating model performance metrics.
416+
417+
Model performance and data distributions can be tracked over time by
418+
designating one or more tables that contain input data and target values.
419+
Performance metrics can be updated by uploading a data set for a new time
420+
period and executing the performance definition.
416421
417422
Parameters
418423
----------
@@ -423,14 +428,19 @@ def update_performance(data, model, label, exec=True):
423428
label : str
424429
The time period the data is from. Should be unique and will be
425430
displayed on performance charts. Examples: 'Q1', '2019', 'APR2019'.
426-
exec : bool, optional
427-
Whether to execute the performance definition with the new data
431+
refresh : bool, optional
432+
Whether to execute the performance definition and refresh results with
433+
the new data.
428434
429435
Returns
430436
-------
431437
CASTable
432438
The CAS table containing the performance data.
433439
440+
See Also
441+
--------
442+
:meth:`model_management.create_performance_definition <.ModelManagement.create_performance_definition>`
443+
434444
"""
435445
from .services import model_management as mm
436446
try:
@@ -440,7 +450,7 @@ def update_performance(data, model, label, exec=True):
440450
"performance data.")
441451

442452
# Default to true
443-
exec = True if exec is None else exec
453+
refresh = True if refresh is None else refresh
444454

445455
model_obj = mr.get_model(model)
446456

@@ -542,7 +552,7 @@ def update_performance(data, model, label, exec=True):
542552
promote=True)).casTable
543553

544554
# Execute the definition if requested
545-
if exec:
555+
if refresh:
546556
mm.execute_performance_definition(perf_def)
547557

548558
return tbl

0 commit comments

Comments
 (0)