@@ -411,8 +411,13 @@ def submit_request():
411
411
return module
412
412
413
413
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.
416
421
417
422
Parameters
418
423
----------
@@ -423,14 +428,19 @@ def update_performance(data, model, label, exec=True):
423
428
label : str
424
429
The time period the data is from. Should be unique and will be
425
430
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.
428
434
429
435
Returns
430
436
-------
431
437
CASTable
432
438
The CAS table containing the performance data.
433
439
440
+ See Also
441
+ --------
442
+ :meth:`model_management.create_performance_definition <.ModelManagement.create_performance_definition>`
443
+
434
444
"""
435
445
from .services import model_management as mm
436
446
try :
@@ -440,7 +450,7 @@ def update_performance(data, model, label, exec=True):
440
450
"performance data." )
441
451
442
452
# Default to true
443
- exec = True if exec is None else exec
453
+ refresh = True if refresh is None else refresh
444
454
445
455
model_obj = mr .get_model (model )
446
456
@@ -542,7 +552,7 @@ def update_performance(data, model, label, exec=True):
542
552
promote = True )).casTable
543
553
544
554
# Execute the definition if requested
545
- if exec :
555
+ if refresh :
546
556
mm .execute_performance_definition (perf_def )
547
557
548
558
return tbl
0 commit comments